v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

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-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

namestring required

The name of the webhook event.

urlstring uri required

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

event_typesstring[] 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

Example request

{
  "name": "Test Webhook Event"
}

Response

201

idstring required

business_idstring required

namestring required

urlstring required

event_typesstring[] required

created_atstring required

updated_atstring required