Appearance
Webhook Endpoints
TL;DR:
- Save async webhook targets for background data delivery.
- Used when you want to notify external apps (Zapier, Make, custom backends) without waiting for a response in the chat.
- Review the full JSON event payload format below.
Overview
Webhook Endpoints are destination URLs where your scenarios can post event data in the background. Unlike Sync HTTP, webhooks are asynchronous — the bot sends the payload and immediately proceeds to the next scenario node without waiting for a reply.
Location: Workspace Settings → Integrations → Webhooks
Configuring a Webhook
Each endpoint requires only:
- Name: Internal label (e.g.,
Zapier CRM Hook). - URL: The target webhook URL.
After saving it, select it in any scenario Actions node.
Webhook Payload Reference
When a scenario triggers a webhook action, the platform sends a POST request with a JSON body.
Top-Level Payload Fields
| Field | Type | Description |
|---|---|---|
event_id | string | Unique event ID |
kind | string | "webhook" or "email" |
org_uid | string | Organization UID |
bot_uuid | string | Bot UUID |
user_id | number | null | Telegram user ID |
user_uuid | string | BotUser UUID (useful for CRM linking) |
scenario_uuid | string | Scenario UUID |
system | object | Telegram user identity properties |
context | object | Raw context variables |
fields | object | Custom fields mapped to labels |
globals | object | Changed global variables (differs from defaults) |
utm | object | Campaign UTM parameters |
tags | string[] | Mapped user tags |
Example Payload JSON
json
{
"event_id": "evt_12345abcde",
"kind": "webhook",
"org_uid": "org_98765xyz",
"bot_uuid": "bot-uuid-1234-5678",
"user_id": 123456789,
"user_uuid": "user-uuid-9876-5432",
"scenario_uuid": "scen-uuid-1111-2222",
"system": {
"first_name": "Alice",
"last_name": "Smith",
"full_name": "Alice Smith",
"username": "alice_smith",
"language_code": "en",
"telegram_user_id": 123456789,
"telegram_chat_id": 123456789,
"chat_type": "private",
"subscribed": true
},
"fields": {
"Email": "[email protected]",
"Phone": "+1234567890",
"Appointment Date": "2026-05-10T10:00"
},
"globals": {
"Discount Code": "BONUS10"
},
"tags": ["VIP Tag", "Lead"]
}