Webhook Events
Create a Webhook Event
This endpoint allows you to create a webhook event. The webhook event will listen to the event types that you specify and send a POST request to the URL that you specify.
POST
/
v1
/
webhook-events
Headers
X-BUSINESS-API-KEY
string
requiredBody
application/json
name
string
requiredThe name of the webhook event.
url
string
requiredThe URL of the webhook, must be a valid URL with https
protocol
event_types
string[]
requiredThe 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
Response
201 - application/json
id
string
requiredbusiness_id
string
requiredname
string
requiredurl
string
requiredevent_types
string[]
requiredcreated_at
string
requiredupdated_at
string
requiredWas this page helpful?