Create Webhook

POST

https://api.zebracat.ai/v1/webhooks

Webhooks

A unique secret is generated automatically and returned in the response. Use this secret to verify incoming webhook payloads via HMAC-SHA256 signature in the X-Webhook-Signature header.

Request body:

url (required) — The HTTPS endpoint to receive events

name (optional) — A label for this webhook (e.g. Production, Staging)

events (optional) — List of event types to subscribe to. If omitted or empty, the webhook receives all events.

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

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Body

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.zebracat.ai/v1/webhooks' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "http://example.com",
    "name": "",
    "events": []
}'

Response Example

201 - Example 1

{
    "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"
}

List Webhooks

Get Webhook