API Documentation

/webhook

The events and payloads documented in this section are webhooks — they are not endpoints your system should call, but rather requests that will be sent from our servers to your system when relevant events occur. These webhook payloads are delivered as HTTP POST requests to a URL you configure during integration.

This page documents all events the webhooks can be configured to fire, and the structure of the payloads your system should expect to receive. Your system must expose an endpoint to receive these POST requests, and handle the incoming JSON payload according to the schema.

Note: You should respond with a 2xx HTTP status code to acknowledge receipt. The system will not retry requests upon failure.

Language
Click Try It! to start a request and see the response here!