Developer

Integrate
your own stack.

Bring your own messaging source via the API channel. Get notified when conversations open, leads are captured, or handoffs happen — pipe them into whatever you run.

Two building blocks

API channel for inbound messages. Webhooks for outbound events.

POST
/v1/messages
Send inbound message events from your own system into the TelyChat inbox. The conversation history attaches and the AI responds using your knowledge base — just as it would on WhatsApp or Instagram.
GET
/v1/conversations
List and filter conversations in your workspace. Filter by status (open, resolved, pending), channel, date range, or agent assignment. Paginated, cursor-based.
GET
/v1/leads
Retrieve captured leads with their collected details, conversation reference, and capture timestamp. Pipe to your CRM or spreadsheet on a schedule.
POST
/v1/webhooks
Register a webhook URL to receive real-time event payloads: message.created, lead.captured, handoff.triggered, conversation.resolved.
DELETE
/v1/webhooks/:id
Remove a webhook endpoint. Future events matching that registration will no longer be delivered. Confirmation returned synchronously.
GET
/v1/workspace
Return workspace metadata: tier, usage counters, active channel count, and add-on entitlements. Useful for dashboards that need to display quota status.

Live event stream

What your webhook endpoint receives in real time.

Webhook payload log LIVE
2026-10-07 09:12:04 message.created { "channel":"whatsapp", "contact":"Ngozi A.", "content":"How much is delivery?" }
2026-10-07 09:12:05 message.created { "direction":"outbound", "sent_by":"Telychat", "content":"Delivery is ₦1,500 within Lagos..." }
2026-10-07 09:12:28 lead.captured { "name":"Ngozi A.", "phone":"+234...", "conversation_id":"conv_8b2f" }
2026-10-07 09:14:11 handoff.triggered { "reason":"uncertainty", "conversation_id":"conv_8b2f", "assigned_to":null }

How authentication works

Keys are per-workspace, scoped to messaging events — not billing or account ops.

Bearer token
Issued from the dashboard under Settings → API Keys. One key per workspace. Rotate without downtime — old key stays valid for 60 seconds during rotation.
Webhook secret
Inbound webhook endpoints require a secret in the request header. If the secret is not configured or mismatches, the endpoint refuses every request — fail-closed, not fail-open.
Tenant isolation
Keys are scoped to one workspace. A key cannot query another tenant's conversations, leads, or webhook registrations — enforced at the database layer, not just middleware.

Honest scope

What the API covers — and what it doesn't yet.

✅
Messaging events, lead capture notifications, handoff events, conversation status changes. Conversation history read. Agent assignment write.
🚧
Billing mutations, payout operations, storefront integrations, and knowledge base writes are not available through the API today. Email us if these are blockers.

Ready to integrate?

Keys are issued per workspace from the dashboard. If your requirements go beyond the current scope, write to us — we'll tell you what's possible and what isn't.