Webhook

Introduction

When an event occurs on the platform, the webhook will send a POST request to the URL you have configured in your system. This request contains a JSON payload with details of the event. Below is the structure of the payload you will receive, along with descriptions of the included fields.

For information on managing webhooks (POST, DELETE, GET, PATCH), please refer to the Public / Notifications section.

Expected Response

Your system must respond with an HTTP 200 status code to confirm the successful receipt of the webhook.

Retry

In case your system fails to respond with an HTTP 200 status code, our platform will attempt to deliver the webhook up to three times. The retries will be spaced out over progressively longer intervals to ensure delivery without overwhelming your system. If after three attempts the webhook still fails, the delivery process will be considered unsuccessful, and no further attempts will be made.