Sign in to run requests with your own sandbox key. Sign in

WebhookEnvelope

The body of every webhook delivery. `data` is event-specific — see `x-webhooks`. Nil-valued fields are omitted from `data` rather than sent as `null`.

Type: WebhookEnvelope

WebhookEnvelope has 4 top-level fields; id, event, created_at, data are always present. Fields typed as another schema link to that schema's page, and nested objects expand in place below. The machine-readable definition is #/components/schemas/WebhookEnvelope in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

  • id string (uuid) required Event id. Identical across every subscriber's copy of the same event and across retries; use it to de-duplicate.
  • event string required Lifecycle events Cascades can deliver. See `x-webhooks` for each payload. One of execution.completed execution.failed adverse_action.triggered adverse_action.completed adverse_action.failed adverse_action.retry_scheduled
  • created_at string (date-time) required When the event was emitted (not when this attempt was sent).
  • data object required
Was this page helpful?