Register Webhook

Registers a webhook subscription: the action to be notified about, the destination URL, and the token that is sent in the Webhook-Token and Authorization headers on delivery.

POST/api/webhooksAuth: Required

Request Body

actionstringRequired

The event class to be notified about. One of deposit, withdrawal, order, trade or market.

tokenstringRequired

A value you choose. It is sent back on every delivery, in both the Webhook-Token and Authorization headers. See Webhook Deliveries.

urlstringRequired

Webhook destination URL

Response

The subscription.

idnumberRequired

The subscription id.

actionstringRequired

The event the subscription is for — see Webhook Deliveries.

tokenstringRequired

The value sent back on every delivery, in both the Webhook-Token and Authorization headers, so you can tell that a call came from us. See Webhook Deliveries.

urlstringRequired

The endpoint deliveries are sent to.

updated_atstringRequired

When the record last changed.

created_atstringRequired

When the record was created.

Errors

Beyond the shared errors:

Code	Meaning
1001	action is not one of deposit, withdrawal, order, trade, market

POST/api/webhooks

curl -X POST 'https://api.example.com/api/webhooks' \
  -H 'Api-Token: YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '<body>'

BODY

{
  "action": "deposit",
  "token": "3f9c1b7e",
  "url": "https://example.com/hooks/deposits"
}

EXAMPLE RESPONSE

{
  "id": 2068,
  "action": "deposit",
  "token": "3f9c1b7e",
  "url": "https://example.com/hooks/deposits",
  "updated_at": "2026-08-28T15:43:30.281Z",
  "created_at": "2026-08-28T15:43:30.281Z"
}