Register Webhook

Registers a webhook subscription: the action to be notified about, the destination URL, and the token that is sent as the Authorization header 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

Token used as Authorization header in webhook calls

urlstringRequired

Webhook destination URL

In progress

The response fields for this endpoint are still being written up. Until then, the Swagger UI lets you run the call and see the actual response.

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": "whk_2f9c1a4b7e",
  "url": "https://merchant.example/hooks/deposit"
}

Response

Answers 201. Response fields are still being written up.

Request Body​

Errors​

Request Body

Errors