POST
/
v1
/
webhook-events

Headers

X-BUSINESS-API-KEY
string
required

Body

application/json
name
string
required

The name of the webhook event.

url
string
required

The URL of the webhook, must be a valid URL with https protocol

event_types
enum<string>[]
required

The event types that the webhook will listen to. The available events: charge.created, charge.updated, payout.created, order.created, order.updated, invoice.created, transfer.created, transfer.updated

Available options:
charge.created,
charge.updated,
payout.created,
order.created,
order.updated,
invoice.created,
invoice.updated,
transfer.created,
transfer.updated

Response

201 - application/json
id
string
required
business_id
string
required
name
string
required
url
string
required
event_types
string[]
required
created_at
string
required
updated_at
string
required

Was this page helpful?

Get webhook event detailsUpdate webhook event