Webhooks

Register a webhook endpoint

Registers a public https URL for video.completed / video.failed events. The response includes the signing secret (shown once). Verify deliveries via the Vivideo-Signature: t=<ts>,v1=<hmac> header, where v1 = hex(hmac_sha256(secret, "<ts>.<raw body>")). Deliveries retry with backoff (1m, 5m, 30m, 2h, 6h); dedupe on the event id. Max 5 active endpoints per account.

post/v1/webhooks

Request

Base URL
https://api.vivideo.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/vivideo/apis/vivideo-api/docs/v1/webhooks/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

urlstring required

eventsstring[]

Example request

{
  "url": "https://example.com/vivideo-webhook"
}

Response

Endpoint registered — store the secret now.

idstring

objectstring

urlstring

eventsstring[]

statusstring

created_atinteger

secretstring

Signing secret (whsec_...) — returned ONLY at creation.

Example response

{
  "id": "whk_9f8e7d6c5b4a3210",
  "object": "webhook_endpoint",
  "status": "active"
}

Changes

No recorded changes to this operation across all 1 revision of this API.