Skip to navigation
Advanced

Webhooks

Use webhooks to receive HTTP notifications when a task reaches a final status. The platform sends notifications for the following events:

  • A video indexing task finishes or fails.
  • An asynchronous analysis task becomes ready, fails, or is canceled.

Tasks created as part of a batch do not produce per-task notifications for asynchronous analysis.

Note

Webhooks are not available for the Embed API.

Set up webhooks

To receive notifications, complete the following steps:

  1. Create an HTTP endpoint in your application. The platform sends each notification as a POST request with a JSON body. For the payload structure, see the Notification schema page.
  2. Register the endpoint. Add your endpoint on the Webhooks page in the Dashboard. For details, see Register a webhook.
  3. Process each notification. Verify the signature and return a 2xx status code. For details, see Requirements for processing notifications.