Skip to main content

Get Event Sample

GET 
/api/webhook-events/:event/sample

Returns up to 3 most-recent real records for the named event, each shaped exactly like the live webhook payload. Backs sample-record discovery for connected apps. Returns an empty data array if the tenant has no matching records yet.

Requires webhooks:manage AND the event's own READ scope (e.g. orders:read for sales_order.* events) — a token with only webhooks:manage receives 403.

Request​

Responses​

OK

Response Headers
    Content-Type