Private beta30 seats for the $9 test film.Check a niche

DocsTeams and API

Webhooks

Get a request to your server when a film is ready, instead of polling. Part of the planned API.

Status: Planned

Planned

This page describes a feature that is designed but not built yet. The changelog shows what is live today. Changelog

Registering a webhook

On /app/developers, choose “Add webhook”, enter an HTTPS URL on your server, and select the events to receive. The page shows a signing secret for the webhook; store it with your server’s other secrets.

film.ready

Sent when a film has passed its checks and its upload package is available. The JSON body contains the event name, the film id, the channel id, the film’s length and the time it became ready. Fetch the package with GET /films/{id}/package.

Verifying requests

Each delivery is signed with the webhook’s secret. Verify the signature, as described on the developers page, before you trust a request, and reject requests that fail.

Delivery

  • Respond with any 2xx status within a few seconds; do the real work afterwards.
  • Failed deliveries are retried several times with increasing delays.
  • Deliveries can arrive more than once. Use the film id to ignore duplicates.
  • The developers page lists recent deliveries with their response codes, and lets you resend one.

Testing

Use “Send test event” on the developers page to deliver a sample film.ready to your URL without starting a film.