registercheckby openlaw group
API referenceDeliveries

Delivery

Sent to each of your active webhook destinations whose enabled_events includes delivery (the default): the delivery itself (object: "delivery"), exactly as GET /deliveries/{delivery_id} lists it, with the events it carries. A webhook destination is always instant, so each delivery carries one event; read events as an array anyway. The body is JSON, sent with Content-Type: application/json.

Deliveries are signed with the Standard Webhooks scheme, under Svix's header names: 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. test is true only on the delivery POST /destinations/{destination_id}/test sends, and false on every other one.

Response Body

Example Requests

POST/delivery