WebhookDeliveryEnvelope

Fields every webhook delivery carries next to the event payload. The body is signed as sent; unknown keys must be ignored.

eventIdstringrequired

Persisted event ID; stable across redeliveries and replays.

eventTypestringrequired

Event type wire name, e.g. payment.completed.

locationIdstring

Owning location, when the event is location-scoped.

merchantIdstring

Owning merchant, when the event is merchant-scoped.

organizationIdstring

Owning organization.

sourceReferencestring

ID of the originating record in the source service.

sourceServicestring

Gateway service that recorded the event.

timestampstring<date-time>required

When the event was recorded (ISO-8601 instant).

WebhookDeliveryEnvelope
{
  "eventId": "string",
  "eventType": "string",
  "locationId": "string",
  "merchantId": "string",
  "organizationId": "string",
  "sourceReference": "string",
  "sourceService": "string",
  "timestamp": "2024-07-29T15:51:28.071Z"
}