Omnix Guides Portal

Welcome to the Omnix Guides Portal. Here you will find comprehensive, task-oriented tutorials, reference materials, and integration schemas. The guides are organized into two primary hubs based on how you interact with the platform.

Choose Your Path

                               +-----------------------------+
                               |     OMNIX GUIDES PORTAL     |
                               +-----------------------------+
                                              |
                       +----------------------+----------------------+
                       |                                             |
                       v                                             v
        +-----------------------------+               +-----------------------------+
        |     📘 USER GUIDES HUB      |               |     🔌 DEVELOPER HUB        |
        |  "I operate the dashboard"  |               |  "I write API integrations" |
        +-----------------------------+               +-----------------------------+
                       |                                             |
        - Inbox & CRM Operations                      - API Keys & Client Auth
        - Channel Connection Guides                   - Web Chat Widget Embed
        - Telephony & IVR Setup                       - OTP Verification Flow
        - AI Workforce & Automations                  - Voice SIP & Call Controls

📘 User Guides Hub

For customer support agents, queue managers, and workspace administrators. These guides walk through configuring and using the Omnix web application without needing to write code.

Section	Description	Key Reference Articles
Getting Started	Initial orientation, account sign-up, and inviting teammates.	Signing Up, Team Invites
Unified Inbox	Operating the central conversation pane, replying, and logging tickets.	Unified Inbox Intro, Sending Messages, Tickets
Channels	Connecting mailboxes, WhatsApp Business numbers, SMS lines, and Web Chat widgets.	WhatsApp Setup, Email Integration, Web Chat
Contacts & CRM	Managing customer profiles, matching identities, and segmenting audiences.	Contacts Overview, Audiences
AI Workforce	Configuring in-app assistants, setting up custom bots, and managing human handoffs.	OmnixAssistant, Bot Handoff Rules
Telephony	Provisioning user extensions, setting up ring groups, and building IVR menus.	SIP Extensions, Call Queues, IVR Builder
Workflows	Building automated triggers, action conditions, and scheduling routines.	Workflow Builder, Action Blocks Catalog
Admin Settings	Managing workspace permissions, generating API keys, and handling billing.	Billing, API Key Creation

👉 Launch the User Guides Hub

🔌 Developer Hub

For software engineers, system integrators, and DevOps teams connecting external applications to the Omnix Gateway RPC engine.

Section	Description	Key Reference Articles
Quickstart	Authentication header format, your first API request, and status codes.	Authentication, First API Call
Core Concepts	Understanding contact schemas, subscription scoping, and channels.	Contact Matching, Channels Constraints
Use Cases	Step-by-step code flows for OTP delivery, notification relays, and telephony control.	OTP flow, AI Agent Webhooks, SIP Call control
API Reference Hub	Base URLs, rate limit tiers, pagination formats, and error codes.	Reference Index, ContactSchema Spec

👉 Launch the Developer Hub

📖 Direct API Reference Catalog

If you are looking for machine-generated endpoint guides covering parameters, schemas, and cURL commands:

OmnixGatewayRpc Reference — Core External API (Contacts, OTP, messaging, telephony).
UnifiedInboxRpc Reference — Agent workspace conversations and assignments.
OmniContactsRpc Reference — CRM profile operations.
ChannelManagerRpc Reference — Channel setup and verification.
Workflow Catalog Reference — Queues and workflow assets.

👉 View all API endpoints