Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

Partner API key. Format: sk_branch_<32chars>, sk_personal_<32chars>, or pk_<32chars> (public, read-only)

Body

application/json
url
string<uri>
required
Example:

"https://example.com/webhooks/exchange"

events
enum<string>[]
required
Minimum array length: 1
Available options:
order.created,
order.status_changed,
order.cancelled,
offer.updated
Example:

Response

Webhook registered. The secretKey field is shown only in this response.

id
string<uuid>
Example:

"550e8400-e29b-41d4-a716-446655440000"

url
string<uri>
Example:

"https://example.com/webhooks/exchange"

events
enum<string>[]
Available options:
order.created,
order.status_changed,
order.cancelled,
offer.updated
Example:
isActive
boolean
Example:

true

failCount
integer
Example:

0

createdAt
string<date-time>
updatedAt
string<date-time>
secretKey
string

HMAC-SHA256 signing secret. Shown only once — store securely.

Example:

"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"

note
string
Example:

"Store this secret key securely — it will not be shown again. Use it to verify HMAC-SHA256 signatures."