Skip to main content
POST
Register a webhook

Authorizations

Authorization
string
header
required

An API key (hk_live_… / hk_test_…) with read/taker/maker scopes.

Body

application/json
url
string<uri>
required

https only. Registration rejects an address LITERAL that is non-public, but does no DNS — a hostname resolving into a private range registers fine and then fails every delivery, visible only as lastStatus. Delivery resolves and re-checks at connect time, follows no redirects, and times out after 10s.

events
string[]

Response

created — { webhook, secret }

The response is of type object.