Webhooks

Create webhook

Register an account endpoint. Registered deliveries are signed with HMAC-SHA256(secret, timestamp + "." + raw body). There are at most 5 total attempts (initial plus retries after 30, 60, 120 and 240 seconds), a 10-second HTTP timeout, and no redirect following. Endpoints are disabled after 20 consecutive exhausted deliveries. Creation and GET by ID return the signing secret.

post/api/webhooks

Request

  • Base URL: https://api.zvid.io
  • URL: https://api.zvid.io/api/webhooks
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

urlstring uri required
descriptionstring
eventsstring[]

Response

Webhook created (includes secret)

idstring required
urlstring required
descriptionstring
eventsstring[] required
status'active' | 'disabled' required
secretstring

Returned by creation and single-webhook lookup; omitted from list/update responses.

consecutiveFailuresinteger
lastSuccessAtstring nullable
lastFailureAtstring nullable
lastFailureReasonstring nullable
createdAtstring
updatedAtstring

Changes

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