Webhooks

Overview

Webhooks available for our Customer API allow developers to subscribe to entity changes in the system instead of polling for updates. A webhook notifies your application by sending outgoing HTTP requests to a URL of your choosing.

The Webhooks Subscription API exposes endpoints you can use to create webhooks, define the events notifications you want to receive, set callback URLs, and remove webhooks when they are no longer needed.

If your application is integrating using OAuth 2.0, you will need to ensure you have included the necessary Access Scopes to create a webhook. Additionally, OAuth 2.0 credentials must be associated with an Admin system role or, if using a different system role, the Manage webhooks toggle must be enabled in the Permissions settings. For detailed information on setting up permissions, please refer to our Help Center.

Learn more about the different options for connecting to our Customer API.