Documentation
Engage & Channels
WhatsApp, Telegram, USSD, SMS, push, email, web chat, campaigns, and chatbot-to-agent handoff.
Engage is the omnichannel layer — configure providers, sync templates, run scheduled campaigns, deliver SMS and OTP, embed web chat, and route inbound events to Flow with chatbot control and agent handoff.
Supported channels
- WhatsApp — Cloud API proxy, embedded signup, template lifecycle
- Telegram — bot webhooks, inline keyboards, payments
- USSD — telco short-code menus via Flow
- SMS — transactional and campaign delivery
- Push — FCM and APNs (see Push docs)
- Email — templates and campaigns (see Email docs)
- Web chat — embeddable widget (see Web Chat docs)
WhatsApp embedded signup
- Connect a WABA via /v1/engage/whatsapp/embedded-signup/*
- Register phone numbers and attach credit lines
- Sync and submit templates for Meta approval
Campaigns & scheduling
- POST /v1/engage/campaigns — create WhatsApp or email campaigns
- POST /v1/engage/campaigns/{id}/send — immediate or scheduled send
- Campaign worker supports recurrence and audience segments from CRM
Chatbot control & handoff
Inbound messages respect conversation control_mode: bot, pending_handoff, or agent. Agents take over from the console or via Inbox APIs; Flow handoff nodes set pending_handoff automatically.
Webhooks (no API key)
- GET/POST /v1/engage/webhooks/meta — Meta WhatsApp events
- POST /v1/engage/webhooks/telegram — Telegram Bot updates
- POST /v1/engage/webchat/* — public web chat widget endpoints
WhatsApp Cloud API routes live under /v1/engage/whatsapp/cloud/*. Requires engage:whatsapp_cloud:read|write and the cloud_api feature.