Skip to main content
POST
Register or update a merchant webhook URL

Authorizations

Authorization
string
header
required

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

Body

application/json

Webhook configuration input

Webhook configuration input

webhook_url
string<uri>
required

The URL where webhook notifications will be sent

Example:

"https://example.com/webhook"

merchant_id
string<uuid>

Merchant ID. Defaults to the logged-in merchant if not provided. Required for admin tokens.

Example:

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

Response

Success

success
boolean
required

Indicates if the request was successful

Example:

true

data
Webhook · object
required

Webhook configuration