Skip to content

WebhookEnvelope

The body of every webhook request, in the Standard Webhooks format. An event can arrive more than once, so skip any id you have already handled. Ignore fields and event types you do not know: schema_version 1 only ever adds them.

Fields

Nested fields are written with dots; [] marks the items of an array.

FieldTypeAlways presentDescription
dataobjectyes—
emitted_atdate-time (RFC 3339, UTC)yes—
idstringyesDelivery ID, the same as the webhook-id header. It stays the same on every retry.
schema_versionintegeryesOne of: 1.
stream_seqintegernoPosition of a filing.* event in the filing stream.
subscriptionobject | nullnoThe subscription that produced the event, as {id, name}. Null for a test send. Not present on endpoint.verification.
subscription.idstringno—
subscription.namestringno—
testbooleanyesTrue for a test send from POST /v3/callbacks/endpoints/{id}/test. Test sends carry sample data and are not billed.
typestringyes—

Markdown version: /docs/reference/schemas/webhook-envelope.md