Webhooks

Instead of waiting for an Assembly to finish and its API request to respond, you can also configure a Webhook, also known as an Assembly Notification. The system will send a POST request to a URL of your choosing containing a full report once an Assembly ends.

Why use Webhooks?

By choosing to use Webhooks you enable your end-users to have a smoother experience, as they only need to wait for file uploads to finish before they can close the browser window. Without file uploads, they could even close the browser window right away.

Configure and verify Webhooks

The canonical Webhooks API documentation covers configuration fields, payload filters, delivery policy, wire format, signature verification, and a timing-safe Node.js example.

Testing Webhooks locally

Run your webhook handler locally, then expose it with Cloudflare Tunnel, ngrok, or the first-party @transloadit/notify-url-relay. The relay polls public Assembly Status and forwards terminal Notifications to your local notify_url handler.

$ TRANSLOADIT_SECRET=******** npx -y @transloadit/notify-url-relay \
    --notifyUrl "http://127.0.0.1:3020/transloadit_pingback" \
    --log-level info

When using the relay, point your app or SDK’s Transloadit endpoint to http://127.0.0.1:8888. You can also retry a Notification from its Assembly page.