Creating webhook subscriptions
Every aspect of webhooks creation and management is controlled through the Webhooks subscription API at this time. A subscription object is composed of a callback URL and the array of events that the consumer would like to be notified about.
To create a webhook, use the following endpoint:
Specify the callback URL and the list of events your application is interested in. You can include as many events as you would like.
You can find the full list of available event subscriptions under the “Callbacks” tab of the POST /subscriptions endpoint in Live Docs.
Please consider securing your webhook endpoint with authentication. Please check "callbackAuthentication" property in POST /subscriptions.
Webhooks and Access Groups
Our webhook system does not factor in access groups when sending notifications to subscribers. This means that when you create a subscription using API key or OAuth credentials with an assigned access group, we do not take that access group into account when sending notifications for such subscription.
- All subscribers receive notifications for events they're subscribed to, regardless of access group restrictions
- Notifications contain only resource IDs, not the full resource data
- Access group enforcement happens at the API level when you query our API using the ID from the notification
When you receive a webhook notification, you should use your authentication method to retrieve the full resource data via the link provided in the notification header. At this point, standard access group restrictions apply - you will only be able to retrieve data for resources that your authentication method has access to based on its assigned access group.
Updated 6 days ago