List Webhooks

Returns all webhooks for the authenticated user.

Each webhook includes:

url — The endpoint that receives POST requests

secret — HMAC-SHA256 signing secret for verifying incoming payloads

events — List of subscribed event types (empty = all events)

is_active — Whether the webhook is currently enabled

Available event types:

video.completed — Fired when a video finishes rendering

video.failed — Fired when a video render fails

project.created — Fired when a new project is created

project.updated — Fired when a project is updated

credit.low — Fired when credit balance drops below threshold

Webhook payload structure

When an event fires, a POST request is sent to your URL with:

Headers:

Content-Type: application/json

X-Webhook-Signature — HMAC-SHA256 hex digest of the raw request body, signed with your webhook secret

X-Webhook-Event — The event type string (e.g. video.completed)

Body (JSON):

{
  "event": "video.completed",
  "data": {
    "task_id": "abc123",
    "video_type": "idea",
    "video_url": "https://storage.example.com/video.mp4"
  }
}

video.failed example:

{
  "event": "video.failed",
  "data": {
    "task_id": "abc123",
    "video_type": "idea",
    "error": "Rendering timed out"
  }
}

Signature verification (Python):

[ { "id": 0, "url": "http://example.com", "name": "string", "secret": "string", "events": {}, "is_active": true, "created_at": "2019-08-24T14:15:22.123Z", "updated_at": "2019-08-24T14:15:22.123Z" } ]

Webhook payload structure

Request

Responses

List Webhooks

Webhook payload structure#

Request

Responses

Webhook payload structure