Webhook Endpoints

Set up endpoints to capture incoming webhook requests.

In order to receive webhook requests from our API, you need an endpoint, which is a publicly accessible URL that supports HTTPS. Your application should receive the request, parse the payload and perform whatever operations you require.

Endpoint Requirements

RequirementDescription
Public URL In order to make successful requests to your endpoint, its URL must be publicly available via the Internet.
Support HTTPS We only make requests over HTTPS. HTTP is not supported.
Respond with HTTP Status CodeYour application should respond with a valid HTTP status code, to let us know if the request was successful (e.g. 200, 201) or unsuccessful (e.g. 404, 500). If the request fails we will make attempts to retry.

πŸ“˜

Contact Support to Setup Your Webhook Endpoints

Please contact us via the support chat or email [email protected] to request one or more webhook endpoints to be configured on your account. For each endpoint, please provide the following information:

  • The URL of your endpoint. And;
  • The events you'd like it to be subscribed to.

🚧

HTTPS Only

To maintain security and help safeguard your data, all requests sent to webhooks will be made using HTTPS, which must be supported by your receiving application.


What’s Next