Create a webhook

Subscribe to real-time status updates for customers, virtual accounts, and payments. When you create a webhook, you’ll receive JSON notifications at your specified endpoint whenever status changes occur.

Webhook Payload Mapping:

For details of the payload structure, refer to the respective webhook event definition linked above.

Authentication: Bearer token required

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
endpointstringRequiredformat: "uri"
The HTTPS URL where webhook notifications will be sent. Must be a publicly accessible endpoint that can receive POST requests.
event_typeenumRequired
The type of event to subscribe to.
Allowed values:

Response

Webhook created successfully
idinteger
Unique subscription ID for this webhook subscription.

Errors