Event envelope

View as Markdown

Every webhook arrives in the same envelope. The fields below are present on every event.

event envelope
{
"id": "evt_2nQv8c9aZmYHKr1...",
"type": "customer.health_score_dropped",
"created_at": "2026-05-26T18:42:00.000Z",
"org_id": "org_2bH...",
"livemode": true,
"api_version": "v1",
"data": {
"object": {
"id": "cus_2N...",
"display_id": 4218,
"name": "Acme Corp",
"health_score": 38,
"previous_health_score": 72
},
"previous_attributes": {
"health_score": 72
}
}
}
FIELDS
FieldTypeNotes
idstringStable event id. Use it for idempotent processing.
typestringDot-namespaced event type, e.g. customer.created.
created_atISO 8601When the event fired, not when we delivered it.
org_idstringThe workspace that owns the resource.
livemodebooleanfalse for events from pivotal_test_ keys.
api_versionstringAlways v1 today. Reserved for future versioning.
data.objectobjectThe full resource at the time of the event.
data.previous_attributesobject | nullPresent on *.updated events with the prior field values.
WHAT TO READ NEXT