Skip to main content
Each delivery is an HTTPS POST to your webhook URL with a JSON body. The body is an envelope around the route intent’s /status body.

Headers

The three webhook-* headers follow the Standard Webhooks v1.0.0 specification.

Envelope

The envelope fields use camelCase. The fields inside data follow /status, which uses snake_case in v1. Bodies are at most 256 KiB. data can include transaction_request, the route’s raw calldata, so set your server’s body size limit to at least 256 KiB. Express’s express.raw(), for example, defaults to 100 KB.

The two data shapes

data has the same two shapes as /status.

Pending shape

Before the route intent is committed, data.status is "pending" or "expired" and data has no transaction fields. route_intent.expired and route_intent.approve_confirmed carry this shape. For example, an approve step confirmed on a two-step route:

Transaction shape

From the commit on, data is the transaction payload. Every other type carries this shape. For example, route_intent.success:
These examples are the sample data the Client Dashboard sends as test events, so they use the zero route intent ID and placeholder hashes. A real webhook event carries real values, and includes every field /status would return at that moment. Optional fields such as gas_status appear only when /status would include them. See the /status reference for what each field means. Check data.status before reading any other field of data, the same way you would with a /status response.

Parse after you verify

Verify the signature over the raw bytes first, then parse the JSON. A body you’ve parsed and re-serialized won’t match the signature, because key order and whitespace can change. Verify signatures shows how.