Client Webhooks Setup
Merchants have the flexibility to set up webhooks either through the user-friendly UI or via API requests.
To set up webhook notifications via the dashboard, visit the section for creating an API integration.
To set up webhook notifications through the API, follow these steps:
Create Webhook
Create a webhook using the POST /merchant/clients/:id/webhooks
Specify the merchant's
clientIdof the newly created API integration.
Configure Notification Types
Define desired notification types within request body
See client webhooks for more information.
Define Endpoint URL
Provide the publicly available API endpoint where notifications should be sent.
Upon successful configuration, the webhook subscription will initiate real-time, event-driven communication to your designated API endpoint. This mechanism ensures notification of subscribed events, facilitating continuous awareness of critical business activities.
Note: Webhooks are tied to integration clients, and merchants can create multiple integrations within their account on the dashboard, providing flexibility and customization options.
The following depicts the flow of webhook notifications for an invoice:
