Sign in

v2

latestOpenAPI 3.1.02026-08-0810576180.4 KB
Webhooks

Create Webhook

Register a new webhook subscription.

Creates or updates a webhook subscription for the authenticated client. A secret will be auto-generated for signature verification. If a subscription already exists for the same event_type and webhook_url, it will be updated with a new secret.

Requires x-api-key header.

Returns the subscription details including the secret (only shown once on creation).

post/api/v1/webhooks

Headers

x-api-keystring nullable

Request body

event_type'video.completed' | 'video.failed' required

Supported webhook event types.

webhook_urlstring uri required

The URL to send webhook payloads to

Example request

{
  "event_type": "video.completed",
  "webhook_url": "https://example.com/webhooks/video"
}

Response

Successful Response

idinteger required

Webhook subscription ID

event_type'video.completed' | 'video.failed' required

Supported webhook event types.

webhook_urlstring required

The webhook URL

secretstring nullable

Auto-generated secret for signature verification (only shown on creation)

is_activeboolean required

Whether the subscription is active

created_atstring date-time required

When the subscription was created