Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
Inbox API
Sits on top of Conversations and powers the human-agent surface — who is currently viewing what, internal notes, saved filtered views, conversation routing, and quick-reply macros.
Base path: /v1/inbox
Authentication: Session JWT (this is dashboard-flavored, not server-to-server).
Live presence
Used by the inbox UI to show “X is viewing” + typing indicators. Heartbeat the viewing endpoint roughly every 30 seconds while the conversation is open.
| Method | Path | Purpose |
|---|
POST | /v1/inbox/{conversationId}/viewing | Heartbeat — register caller as viewing |
DELETE | /v1/inbox/{conversationId}/viewing | Unregister (tab close / route away) |
GET | /v1/inbox/{conversationId}/viewers | Who is currently viewing |
POST | /v1/inbox/{conversationId}/typing | Toggle the caller’s typing state |
Internal notes
Team-only notes attached to a conversation. Never visible to the contact; surfaced inline with messages in the inbox UI.
| Method | Path | Purpose |
|---|
POST | /v1/inbox/{conversationId}/internal-notes | Post an internal note |
GET | /v1/inbox/{conversationId}/internal-notes | List internal notes (newest first) |
Saved views
Personal or team-wide filtered views over the conversation list — “My open WhatsApp conversations”, “VIP escalations”, “Stale > 4h”, etc.
| Method | Path | Purpose |
|---|
GET | /v1/inbox/views | List personal + team views |
POST | /v1/inbox/views | Create a view |
PATCH | /v1/inbox/views/{id} | Rename, reorder, or re-filter |
DELETE | /v1/inbox/views/{id} | Delete |
Routing rules
Auto-assign incoming conversations to agents or teams based on channel, contact, content, or time. Rules are evaluated in priority order; first match wins.
| Method | Path | Purpose |
|---|
GET | /v1/inbox/routing-rules | List rules |
POST | /v1/inbox/routing-rules | Create a rule |
PATCH | /v1/inbox/routing-rules/{id} | Update name, priority, condition, action |
DELETE | /v1/inbox/routing-rules/{id} | Delete a rule |
POST | /v1/inbox/routing-rules/test | Dry-run a rule against a sample conversation |
Macros
Saved quick replies with optional variables, attachments, and post-actions (close, tag, assign).
| Method | Path | Purpose |
|---|
GET | /v1/inbox/macros | List personal + shared macros |
POST | /v1/inbox/macros | Create a macro |
GET | /v1/inbox/macros/popular | Most-used macros for this user |
PATCH | /v1/inbox/macros/{id} | Update a macro |
DELETE | /v1/inbox/macros/{id} | Delete a macro |
POST | /v1/inbox/conversations/{convId}/run-macro | Apply a macro to a conversation |
See also
