Configuring a Webhook
Webhooks are self-serve in the Relay Dashboard. Each API key can have a single webhook endpoint, and any requests tied to that key will post events to it. To configure one:- Sign in to the Relay Dashboard.
- Open the API keys tab.
- Open the actions menu on the key you want to configure and select Configure Webhook.
- Enable the webhook and enter your Webhook URL — an HTTPS endpoint to POST to when the status of a request changes (e.g.
https://my.server/receive-relay-event). - Optionally add Custom Headers to include on every webhook request (e.g.
Authorization: Bearer 0x123), then save.
Webhook Events
Relay Webhooks specifically stream transaction statuses for both cross and same-chain status, though the stages differ slightly.Example Payload
referrer field echoes the value supplied on the originating quote request, or null if no referrer was provided. Use it to attribute webhook events back to the request source (campaign, partner, or integration surface) without an extra lookup.
The details, failReason, and refundFailReason fields mirror the same fields returned by GET /intents/status/v3:
By default we post all status updates. If you’re only interested in certain statuses you can filter on the
status property in your endpoint.
Verification
Each webhook request includes two headers for verification:
To verify a webhook is authentic, compute the HMAC-SHA256 hash of
${timestamp}.${body} using your API key as the secret, and compare it to the X-Signature-SHA256 header value.
Example Verification
Webhook Delivery & Reliability
Relay’s built-in webhook service includes up to 10 retries with exponential backoff. For most integrations, this is sufficient. For production deployments requiring guaranteed delivery, routing, fan-out, or detailed observability, we recommend using a webhook gateway like Hookdeck. A gateway sits between Relay and your server, giving you:- Guaranteed delivery with configurable retry policies
- Routing & fan-out to multiple destinations from a single source
- Event inspection & replay for debugging
- Rate limiting to match your server’s capacity
endpoint and route events to your server from there. See Hookdeck’s getting started guide for setup instructions.