Webhooks

Debitsuccess uses webhooks to notify your application when an event occurs in your account. Notifications are the only way you'll receive automatic updates about events that are not triggered by a request from your side, for example when the account suspension schedules are changed.

Currently, we support limited events but may include additional events in the future. You can create webhooks for:

• Account Suspension Notifications

• Payment Status Notifications

To receive notifications, you would need to:

1. Subscribe to Debitsuccess notifications

2. Create an endpoint on your server

3. Accept notifications

4. Test and go live

Securing Webhooks

Once your server is configured to receive payloads, it'll listen for any payload sent to the endpoint you configured. For security reasons, you probably want to consider whitelisting our IP(can be provided during subscription) and/or limit requests to those coming from Debitsuccess.

You could also opt to receive a token to authenticate the messages. The token will be a static text - 256 chars max length.

This will be passed in the request header - X-Token

Delivery attempts and retries

Whenever any webhook fails to send data to the desired notification URL Debitsuccess retries three times every 180 seconds. If a message fails to deliver after 3 retries an email would be triggered to the email address nominated during the subscription and the webhook would be disabled.

Incase you would want any specific messages delivered please contact Debitsuccess.

Subscribe to Debitsuccess Notifications

To subscribe to Debitsuccess webhook notifications, send an email to either testapi.support@debitsuccess.com or liveapi.support@debitsuccess.com with the following information:

• URL - The webhook notification endpoint.

• Token - A unique static text of 256 characters max, that is returned in the notification header (see Securing webhooks section). If not provided, Debitsuccess generates and assigns one for you.

• Facility - The facility/facilities information for notification subscription.

• Events - Events which you wish to receive notifications for.

• Email Address - A nominated email address to receive update in case of notification failure.

Testing

Test webhooks notification in integrations test environment. Separate registration from prod environment

Account Suspension Notifications

Payment Status Notifications

On this page: