This documentation explains all you need to know to integrate with webhook/notification system, which enables your application to receive real-time updates about specific events.
To set up your webhook endpoint, please refer to the "Integrations" section of the "Settings" page on your business dashboard.
Server Requirements
While setting up a route to receive notifications via, please ensure to;
- Return a 2XX Response: To acknowledge receipt of the webhook, your server must return a
2XXHTTP status code. The response body is ignored, and not used or stored by us. - Process Payload: Parse, process, and (possibly store) the JSON payload included in the request body. We would not send a notification more than once.
- Keep the server reachable and over HTTPS to secure communication. In some cases, our system might not send notifications if your webhook is not over secure HTTP.
Request Timeouts
A reequest will be considered failed if the server doesn't respond within 30 seconds.
Retry Mechanism
In situations where your server does not return a 2XX response, the webhook request will be continuously retried using an exponential backoff schedule by power of 10 seconds. This means.
- 1st Retry: 10 seconds after the initial attempt.
- 2nd Retry: 100 seconds after the previous attempt.
- 3rd Retry: 1000 seconds after the previous attempt.
- Subsequent Retries: Each retry will occur with an interval 10 times longer than the previous one, up to a maximum interval of 100,000 seconds.
Our systems will stop retrying after a request succeeds (returns a 2XX response) or the maximum retry interval is reached.
Note!
- Each requests are retried a maximum of 5 times after each failure.
- A request is considered failed if it has exceeded the timeout of 30 seconds or if it returns a non 2XX status code.