Webhooks Overview
Webhooks is a resource that allows you to receive notifications from the server when a specific event occurs. The server sends a POST request to the URL you specify in the webhook when the event occurs. You can use webhooks to receive notifications for various events such as new mentions that occur when using Contextual Comments.
How to receive Webhook notifications
To receive webhook notifications, you need to go to the developer section of the dashboard and add a new webhook.
When adding a new webhook, you need to specify the URL where you want to receive the notifications, the description, and a token if necessary. You can also specify the events you want to receive notifications for.
Events basic structure
All events have the following structure:
| Property | Type | Description |
|---|---|---|
id | string | The event's unique identifier. |
type | string | The event's name. |
message | string | The event's data, please check the specific event for more details about its data. |
If you are looking for Webhooks from the Real-time Data Engine, please check the dedicated documentation.
Webhook Events
The following events are available for webhooks:
CREATE_MENTION: This event is triggered when a new mention is created.DELETE_MENTION: This event is triggered when a mention is deleted.REAL_TIME: This event is triggered when a real-time event occurs.