Skip to main content
To receive real-time notifications about events in the Consul API, register a webhook endpoint with the Create a Webhook endpoint. Consul sends HTTP POST requests to your URL when subscribed events occur. Event notifications have an event_category field that indicates the type of event. Categories are intentionally simple - they only indicate whether an object was created or updated. To get the full object state, fetch it from the relevant API endpoint. This avoids issues with concurrent or out-of-order notifications.

Webhook Delivery

Webhook delivery is considered successful on a 2xx or 4xx response. 5xx responses are retried with exponential backoff up to 8 times. Your webhook handler should return a successful response as soon as possible, ideally immediately passing the event to an event queue or concurrent worker.

Event Categories

EventDescription
deposit.createdA fiat deposit has been initiated
deposit.updatedA fiat deposit status changed (e.g. completed, failed)
inbound_transfer.createdA stablecoin deposit was received on-chain
payout.createdAn on-chain payout transfer was initiated
payout.updatedA payout transfer status changed
withdrawal.createdA fiat withdrawal (off-ramp) was initiated
withdrawal.updatedA fiat withdrawal status changed
recipient.createdA new recipient was created
recipient.updatedA recipient was updated