Skip to content

WebhookFilingDigest

Fields

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

FieldTypeAlways presentDescription
dataobjectyesIts fields follow, as data.….
data.countintegeryes—
data.eventsarray of objectyesEach item's fields follow, as data.events[].….
data.events[].dataobjectno—
data.events[].typestringno—
data.truncatedbooleanyes—
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.
typestringyesOne of: filing.digest.

Markdown version: /docs/reference/schemas/webhook-filing-digest.md