Use Webhooks to receive events to notify you when a variety of interactions or events happen.
The webhook integration is not enabled by default.
For more details on how to enable it, refer to our Configuration Section.
The webhook integration enables you to programmatically participate in conversations by sending messages or reacting to them. Here's a common integration pattern:
- Call the subscribe endpoint
- Consume on your URL of choice events
- React to those events by calling the send message endpoint
You must de-duplicate messages on arrival as the webhook does not guarantee events uniqueness.
Subscribes the webhook for the first time or update its parameters.
After subscribing to an Airy webhook, you will start receiving events on your URL of choice. The event will always be a POST request with one the following payloads: