Skip to main content
GET
Retrieve an event

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Path Parameters

event_id
string
required

Event id.

Pattern: ^evt_[0-9A-HJKMNP-TV-Z]{26}$

Response

The event.

Event envelope (CONVENTIONS §12), exactly as POSTed to webhook endpoints. Kept 30 days for listing and replay.

id
string
required

Event id; receivers dedupe on it.

Pattern: ^evt_[0-9A-HJKMNP-TV-Z]{26}$
object
string
required

Always event.

Allowed value: "event"
type
string
required

Event type, <resource>.<event> (e.g. payment.completed). The catalogue is asyncapi/webhooks.yaml and GET /event-types; clients must tolerate new types.

Pattern: ^[a-z_]+(\.[a-z_]+)+$
Example:

"payment.completed"

created_at
string<date-time>
required

When it happened.

Example:

"2026-10-27T08:41:00Z"

livemode
boolean
required

Mode.

business_id
string
required

Business.

Pattern: ^biz_[0-9A-HJKMNP-TV-Z]{26}$
data
object
required

Payload.

previous_attributes
object

For *.updated-style events: the changed fields' old values.