Skip to main content
POST
Register a webhook
Creates a new webhook endpoint to receive real-time notifications for swap and on-ramp events. Requires a valid API key.
url
string
required
The HTTPS URL to receive webhook payloads.
events
string[]
required
List of event types to subscribe to. See Webhooks Guide for available events.
secret
string
A signing secret for HMAC-SHA256 signature verification. If not provided, one will be generated.
Store the webhook secret securely. You will need it to verify webhook signatures. If you lose it, delete the webhook and create a new one.

Authorizations

X-API-Key
string
header
required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Body

application/json
url
string<uri>
required

Must use HTTPS

events
enum<string>[]
Available options:
swap.completed,
onramp.completed

Response

Webhook created

data
object
required

Response payload (null on error)

error
object | null
required
meta
object
required