Outbound event payload

webhook

event

Zentag POSTs this JSON body to your registered HTTPS endpoint whenever a
subscribed event occurs. Discriminate on type (see enum below).

Event types: clip.created, clip.ready, clip.failed,
highlight.ready, highlight.failed, publish.succeeded,
publish.failed, stream.created, stream.started, stream.ended.

Verify the Zentag-Signature header (t=<unix>,v1=<hmac-sha256>) before
processing. Return 2xx to acknowledge; non-2xx responses are retried
with exponential backoff.

Payload

The signed payload delivered to your endpoint.

string

required

Unique per event. Stable across retries of the same event, so use it as the deduplication key.

type

string

enum

required

created_at

date-time

required

job_id

string | null

The job this event completes, when it was started through the API. Matches the id returned by the 202 that queued it. Null for events originating from activity in the Zentag Studio UI.

idempotency_key

string | null

The Idempotency-Key you sent on the request that started the job. Null when none was sent or when the event was not partner-initiated.

data

required

The resource for this event.

Response

200

Return any 2xx to acknowledge receipt. Acknowledge before doing the work; anything non-2xx (or a timeout) is retried, and a slow handler will produce duplicates.