Skip to content
CXGear CXGear Docs

Welcome to CXGear

CXGear is a customer communication operating system. Teams use it to connect messaging and voice channels, automate follow-ups with spinners (pipelines), put human agents on calls and chats, and analyze completed calls for quality.

This documentation is written for operators, supervisors, and admins — people who run campaigns day to day, not only engineers. Each guide explains what a feature is, why it matters, and how to use it, with screenshots where they help.

Screenshot needed
App home (Live Ops) after login — sidebar and main area visible.
Where: Home / Live Ops
Save as: src/assets/screenshots/01-live-ops-home.png

Who CXGear is for

Section titled “Who CXGear is for”
RoleTypical work in CXGear
AdminUsers, billing, integrations, project setup
SupervisorCampaign health, agent desk, monitoring
AgentTaking calls (and later chats) with presence on
DeveloperAPI keys, webhooks, CRM ingest

What you can do

Section titled “What you can do”
  • Outreach — run multi-channel campaigns (WhatsApp, SMS, email, voice, AI) from a data table of contacts.
  • Post Call Analyzer — transcribe recordings, apply tags, score QA, and review results.
  • Dialler — human agents, presence, inbound call floater, calling lists.
  • Governance — roles, single active session, plan limits, audit-friendly sessions list.

How the product fits together

Section titled “How the product fits together”
  1. You create an organization (your company account).
  2. Inside it you create projects (one campaign or client each).
  3. You load contacts or calls into data tables, and mark metadata fields (the only columns that enter automation).
  4. You build spinners — ordered steps that run for each row.
  5. Each run is a job. Each contact’s result is a record outcome.
  6. Channels and integrations supply WhatsApp numbers, LLM keys, and other connections.

If you only remember one idea: metadata fields are the contract between your spreadsheet and every spinner step.

How to use these docs

Section titled “How to use these docs”
  • Left sidebar — browse by product area (same structure as the product).
  • Search (top) — find a page by name or keyword.
  • Screenshot blocks — gray placeholders show what image to capture; replace them when you have PNGs in src/assets/screenshots/.

Start here

Section titled “Start here”
  1. Core concepts — vocabulary used everywhere
  2. Quickstart — first project and first successful run
  3. Metadata fields — required before serious automation
  4. Trial limits — what Trial allows

Local preview

Section titled “Local preview”
Terminal window
npm run dev:docs

Open http://localhost:4321. Production is intended for https://docs.cxgear.ai.