Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.relay.link/llms.txt

Use this file to discover all available pages before exploring further.

Building applications at scale requires integrating with Relay’s system at instant speed. Rather than polling the API for status updates, webhooks push transaction lifecycle events directly to your server the moment they happen. Configure a webhook endpoint and Relay will notify your backend in real time as quotes are processed — lightweight, no polling, low latency.

​
Integrating Relay Webhooks

Each API key can have a single webhook endpoint configured. In order to configure a webhook you’ll need the following:
FieldDescriptionExample
API keyAny requests tied to this API key will post events to the webhook endpointyour-api-key
EndpointAn HTTPS endpoint to POST to when the status of a request changeshttps://my.server/receive-relay-event
Custom HeadersAny custom headers you wish to receive{"Authorization": "Bearer 0x123", "X-Hookdeck-Source-Id": "src_123"}
Once you have this information reach out to Relay to configure your API key with a webhook endpoint.

​
Webhook Events

Relay Webhooks specifically stream transaction statuses for both cross and same-chain status, though the stages differ slightly.
statusindication
waitingwaiting for origin chain deposit
depositingorigin deposit confirmed via /execute API, fill pending
pendingorigin chain deposit confirmed, fill pending submission
submittedfill submitted on destination chain
successfill succeeded
failurefill failed
refundrefunded

​
Example Payload

{
  "event": "request.status.updated",
  "timestamp": 1774993296140,
  "data": {
    "status": "refund",
    "inTxHashes": [
      "0x..."
    ],
    "txHashes": [],
    "updatedAt": 1774993296121,
    "originChainId": 8453,
    "destinationChainId": 42161,
    "depositAddress": {
      "address": "0x..",
      "depositAddressType": "open", // open / strict
      "depositor": "0x..", //nullable
    }, //nullable
    "requestId": "0x..."
  }
}
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:
HeaderDescription
X-Signature-TimestampUnix timestamp of when the webhook was sent
X-Signature-SHA256HMAC-SHA256 signature of the request
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
import crypto from 'crypto';

function verifyWebhook(req, apiKey) {
  const timestamp = req.headers['x-signature-timestamp'];
  const signature = req.headers['x-signature-sha256'];
  const body = JSON.stringify(req.body);

  const expected = crypto
    .createHmac('sha256', apiKey)
    .update(`${timestamp}.${body}`)
    .digest('hex');

  const signatureBuffer = Buffer.from(signature, 'hex');
  const expectedBuffer = Buffer.from(expected, 'hex');

  return (
    signatureBuffer.length === expectedBuffer.length &&
    crypto.timingSafeEqual(signatureBuffer, expectedBuffer)
  );
}
Requests that fail verification should be rejected with a non-2xx status code.

​
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
To set this up, use your Hookdeck ingestion URL as the Relay webhook endpoint and route events to your server from there. See Hookdeck’s getting started guide for setup instructions.