Skip to main content
POST
Create an outbound webhook subscription

Authorizations

X-API-Key
string
header
required

Body

application/json
url
string<uri>
required
eventTypes
enum<string>[]
required
Required array length: 1 - 32 elements
Available options:
invoice.created,
invoice.approved,
invoice.buyer_invited,
invoice.buyer_kyc_approved,
invoice.buyer_kyc_rejected,
invoice.on_ramp_started,
invoice.fiat_received,
invoice.on_chain_confirmed,
invoice.offramp_initiated,
invoice.settled,
invoice.offramp_failed,
invoice.failed,
invoice.cancelled,
invoice.expired,
payment_intent.created,
payment_intent.buyer_kyc_approved,
payment_intent.buyer_kyc_rejected,
payment_intent.on_chain_confirmed,
payment_intent.settled,
payment_intent.failed,
payment_intent.cancelled,
payment_intent.expired,
connected_account.created,
connected_account.kyb_approved,
connected_account.kyb_rejected,
connected_account.ready_to_collect

Response

Subscription created — secret is surfaced ONCE; persist it on your side.

id
string
required
orgId
string
required
url
string
required
eventTypes
string[]
required
active
boolean
required
createdAt
string
required
updatedAt
string
required
secret
string
required