Webhook request

Below is the sample payload for travel rule events published to the webhook, along with the description of each field.

{
  "request_id": "01954725-66bb-7de1-a0f3-b5dbcdbd47b8",
  "event_type": "travel_rule",
  "event_name": "INCOMING_TRANSFER",
  "timestamp": "2024-12-31T12:40:01.138096+00:00",
  "error": null,
  "data": {
    "transfer_id": "018f85d7-0650-7205-a1d5-011e9587c07c",
    "reference_id": "reference-transfer-01",
    "amount": 1.00,
    "amount_usd": 101234.00,
    "dti": "4H95J0R2X",
    "chain": "bitcoin",
    "symbol": "BTC",
    "protocol": "flow",
    "transaction_hash": null,
    "transfer_status": "REVIEW"
  }
}

Field	Type	Description
request_id	UUIDV7	A unique identifier for the webhook request.
event_type	string	Specifies the module where the event originates (e.g., “TRAVEL_RULE”).
event_name	string	The specific event that triggered the webhook. See the list of Travel Rule events [here].
timestamp	datetime	The date and time when the webhook request was sent.
error	object	Contains error details if an issue occurred during the event processing (null if data is set).
data	object	Contains Travel Rule event details if the request was successful (null if an error is set).