Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Body

application/json
event_type
enum<string>
required
Available options:
payin_credited,
payin_expired,
payout_status_changed,
transfer_received,
crypto_deposit_credited,
crypto_deposit_held,
crypto_deposit_alert,
crypto_withdrawal_status_changed,
banking_customer_status_changed,
banking_operation_status_changed,
aml_screening_updated,
kyc_verification_status_changed,
kyb_verification_status_changed,
kyc_link_completed,
kyb_link_completed,
kyc_document_validated,
kyb_document_validated,
kyc_liveness_completed,
wallet_deposit_received,
wallet_send_status_changed,
wallet_key_exported,
*
callback_url
string<uri>
required

HTTPS only; localhost and private IPs are rejected.

secret
string
required
Minimum string length: 16

Response

Subscription created.

id
string<uuid>
event_type
string
callback_url
string
status
string
Example:

"active"

created_at
string<date-time>
secret_stored
boolean
Last modified on July 18, 2026