Skip to main content
POST
Create Webhook Subscription

Headers

source
string | null
X-API-SIGNATURE
string
required

Signature header

X-API-TIMESTAMP
integer
required

Timestamp header

X-API-NONCE
string
required

Nonce header

X-API-SUBSCRIPTION-KEY
string
required

Account ID header

Body

application/json

Schema to deserialize the webhook subscription request.

event_types
enum<string>
required

Event Type

Available options:
transaction
Example:

"transaction"

callback_url
string<uri>
required

Call back URL

Required string length: 1 - 2083
Example:

"https://example.com/webhook"

description
string
required

Description

Minimum string length: 1
Example:

"Transaction events"

Response

Successful Response

message
string
required
data
WebhookResponse · object | null

Schema to serialize the webhook data.