Skip to main content
POST
Create webhook subscription

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Body

application/json
url
string<uri>
required

Where we send the event. Must use https in production.

eventType
enum<string>
required
Available options:
orderUpdated,
paymentAccountUpdated,
kycUpdated,
kybUpdated

Response

The created subscription, with its secret.

id
string<uuid>
required
eventType
enum<string>
required
Available options:
orderUpdated,
paymentAccountUpdated,
kycUpdated,
kybUpdated
url
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
secret
string
required

HMAC key for verifying deliveries, encoded as URL-safe base64 with padding. Returned only in this response.