Skip to main content
POST
Register a webhook

Authorizations

Authorization
string
header
required

Merchant authentication token. Obtained via POST /api/v1/merchant/token/grant. Pass as: Authorization: Bearer

Body

application/json
url
string
required

Webhook endpoint URL

Maximum string length: 255
description
string

Webhook description

Maximum string length: 255

Response

Webhook registered. Secret is only shown once.

msg
string
required

Human-readable message describing the result

data
object
required

Response payload (null on error)