Delivery
Sent to each of your active webhook destinations: the delivery itself (object: "delivery"),
exactly as GET /deliveries/{delivery_id} lists it, with the events it carries. An instant
destination receives one delivery per event; a daily, weekly or monthly one receives one per
period, with that period's events. The body is JSON, sent with Content-Type: application/json.
Deliveries follow the Standard Webhooks scheme: the
svix-id, svix-timestamp and svix-signature headers sign the raw body with your
destination's secret (shown once, when the destination is created). svix-id is the
delivery's id; a retry carries it again, so de-duplicate on it. Deliveries can arrive out of
order. status and attempt_count say where the delivery stood when this send was made.
An event naming someone taken off the platform since it was decided is left out; a delivery with no event left is not sent.
Free. Delivering costs nothing.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
One send of one or more events to one destination: an instant destination gets one per
event, a daily, weekly or monthly one gets one per period. It is also the webhook body, so
id is the svix-id header: deduplicate on it, a retry carries it again.
Response Body
Example Requests
/delivery