Skip to main content
POST
Use this when you want to register a webhook endpoint that receives one or more event types (`user.verified`, `user.cancelled`, `order.*`).

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required
Maximum string length: 2048
subscribedEvents
enum<string>[]
required
Required array length: 1 - 5 elements
Available options:
user.verified,
user.cancelled,
order.created,
order.status_updated,
order.paid
description
string | null
Maximum string length: 256
enabled
boolean | null

Response

Created

endpointId
string
required
scope
enum<string>
required
Available options:
developer,
merchant
url
string
required
description
string | null
required
enabled
boolean
required
subscribedEvents
enum<string>[]
required
Available options:
user.verified,
user.cancelled,
order.created,
order.status_updated,
order.paid
signingSecretVersion
integer
required
createdAt
string
required
updatedAt
string
required
lastDeliveryAt
string | null
required
lastDeliveryStatus
enum<string> | null
required
Available options:
success,
failure
consecutiveFailures
integer
required
Required range: x >= 0
signingSecret
string
required
Pattern: ^[0-9a-f]{64}$