Reference

Webhook reference

Inspect supported generation events, endpoint schemas, payload shape, signature headers, and delivery behavior.

On this page

Webhook payloads carry the same public generation object returned by the REST API. Workflow-run events are not part of the current registration contract.

01

Endpoint management

POST/v1/webhooks/endpointsCreate an active endpoint and receive its signing secret once.
GET/v1/webhooks/endpointsList endpoints without returning signing secrets.
DELETE/v1/webhooks/endpoints/{endpoint_id}Deactivate an endpoint. A successful response has no body.
02

Supported events

generation.queuedGeneration lifecycle eventPayload contains the current public generation object.
generation.runningGeneration lifecycle eventPayload contains the current public generation object.
generation.succeededGeneration lifecycle eventPayload contains the current public generation object.
generation.failedGeneration lifecycle eventPayload contains the current public generation object.
generation.cancelledGeneration lifecycle eventPayload contains the current public generation object.
generation.manual_reviewGeneration lifecycle eventPayload contains the current public generation object.
workflow_run.queuedGeneration lifecycle eventPayload contains the current public generation object.
workflow_run.runningGeneration lifecycle eventPayload contains the current public generation object.
workflow_run.succeededGeneration lifecycle eventPayload contains the current public generation object.
workflow_run.failedGeneration lifecycle eventPayload contains the current public generation object.
workflow_run.cancelledGeneration lifecycle eventPayload contains the current public generation object.
workflow_run.manual_reviewGeneration lifecycle eventPayload contains the current public generation object.
03

Payload shape

Event payload
{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "generation.succeeded",
  "created_at": "2026-07-12T08:31:14Z",
  "data": {
    "object": {
      "id": "gen_0123456789abcdef0123456789abcdef",
      "object": "generation",
      "status": "succeeded",
      "model": "seedance-2",
      "task": "video.create",
      "created_at": "2026-07-12T08:30:00Z",
      "completed_at": "2026-07-12T08:31:14Z",
      "output": {
        "assets": [
          {
            "id": "asset_0123456789abcdef0123456789abcdef",
            "type": "video",
            "url": "https://cdn.entirefeed.com/examples/product-reveal.mp4",
            "mime_type": "video/mp4",
            "expires_at": null
          }
        ]
      },
      "usage": {
        "amount_usd": "1.20",
        "line_items": [],
        "billing_status": "settled"
      },
      "error": null,
      "metadata": null
    }
  }
}
04

Signature headers

EntireFeed-Signaturet={unix_seconds},v1={hmac_sha256_hex}HMAC-SHA256 over timestamp + period + exact raw body.
EntireFeed-Event-IDevt_...Stable across delivery retries; use it for deduplication.
Retry schedule1m, 5m, 30m, 2h, 12hEach request has a 10-second timeout.