# ChatbotX

## Docs

- [Introduction to ChatbotX: Agentic Omnichannel Chatbot](https://docs.theomnibot.io/introduction.md): Learn what ChatbotX is, which channels it supports, its core capabilities, and how to get started automating conversations in minutes.
- [Quick Start: Get Up and Running with ChatbotX](https://docs.theomnibot.io/quickstart.md): Create your free ChatbotX account, connect a channel, build your first Flow, and publish your chatbot — no credit card required to start.
- [Workspace Dashboard: Manage Workspaces and Account](https://docs.theomnibot.io/workspace-dashboard.md): Learn how to select or create workspaces, review your plan, manage billing, redeem AppSumo codes, and configure account settings from the Workspace Dashboard.
- [ChatbotX Channels: Connect Every Messaging Platform](https://docs.theomnibot.io/channels/overview.md): Browse all messaging channels in ChatbotX — WhatsApp, Messenger, Instagram, Telegram, TikTok, Zalo OA, Email, and Webchat — and start connecting today.
- [Connect WhatsApp Business to ChatbotX via Meta Signup](https://docs.theomnibot.io/channels/whatsapp.md): Complete 6-step guide to connect WhatsApp Business to ChatbotX using Meta Embedded Signup, including credentials, System User setup, and troubleshooting.
- [Connect Facebook Messenger to ChatbotX in 5 Steps](https://docs.theomnibot.io/channels/facebook-messenger.md): Connect your Facebook Page to ChatbotX, configure webhooks, set subscription fields, request advanced access, and go live with the correct permissions.
- [Connect Instagram to ChatbotX: Two Methods Explained](https://docs.theomnibot.io/channels/instagram.md): Connect your Instagram Professional account via Instagram OAuth or Facebook OAuth, then automate DMs, Story Mentions, and Comment-to-DM conversion flows.
- [Connect Telegram Bot to ChatbotX with BotFather Token](https://docs.theomnibot.io/channels/telegram.md): Connect a new or existing Telegram Bot to ChatbotX in 3 steps using a BotFather API token — no app review or credential configuration required.
- [Connect TikTok Business Messaging API to ChatbotX](https://docs.theomnibot.io/channels/tiktok.md): 6-step guide to integrate TikTok Business Messaging with ChatbotX — register a developer app, apply for API access, configure credentials, and authorize.
- [Connect Zalo Official Account to ChatbotX in 5 Steps](https://docs.theomnibot.io/channels/zalo-oa.md): Connect your Zalo Official Account to ChatbotX: create a Zalo developer app, configure credentials, verify your domain, and subscribe webhook events.
- [Set Up a ChatbotX Email Channel Using SMTP Credentials](https://docs.theomnibot.io/channels/email.md): Connect any email address to ChatbotX via SMTP, collect opt-ins, build automated email flows, track performance with Email Topics, and fix common errors.
- [Add a Webchat Widget to Your Website with ChatbotX](https://docs.theomnibot.io/channels/webchat.md): Create a ChatbotX Webchat widget, set authorized domains, customize appearance, configure conversation starters, copy the embed code, and test it live.
- [Building and Managing Conversation Flows in ChatbotX](https://docs.theomnibot.io/automation/flows.md): Learn how to design, manage, and publish automated conversation journeys using ChatbotX's visual Flow Builder drag-and-drop canvas.
- [Flow Actions: All 13 Categories Explained for ChatbotX](https://docs.theomnibot.io/automation/actions.md): Explore every Action available in ChatbotX Flows — from inbox management and contact tagging to AI integrations and Google Sheets sync.
- [Custom Fields: Store and Manage Contact Data in ChatbotX](https://docs.theomnibot.io/automation/custom-fields.md): Create and use Custom Fields to capture business-specific contact data like membership tier, discount codes, and appointment times inside ChatbotX.
- [Keywords: Trigger Automated Responses from Customer Messages](https://docs.theomnibot.io/automation/keywords.md): Set up keyword rules in ChatbotX to detect phrases in customer messages and instantly trigger text replies or full conversation Flows automatically.
- [Triggers & Actions: Event-Based Automation Rules in ChatbotX](https://docs.theomnibot.io/automation/triggers.md): Build event-driven automation rules in ChatbotX that fire when tags change, sequences update, or new contacts arrive — without any manual monitoring.
- [AI Agents: Automate Customer Conversations with AI](https://docs.theomnibot.io/ai-agents/overview.md): Learn how AI Agents work in ChatbotX, how to create one, and how to configure tools, prompts, and rich responses for your business.
- [AI Providers: Connect LLMs to Power Your AI Agents](https://docs.theomnibot.io/ai-agents/ai-providers.md): Connect OpenAI, Gemini, Claude, DeepSeek, OpenRouter, or any OpenAI-compatible LLM to your ChatbotX workspace to power your AI Agents.
- [Knowledge: Upload Business Documents for AI Agents](https://docs.theomnibot.io/ai-agents/knowledge.md): Upload business documents to ChatbotX Knowledge so your AI Agents can search and cite accurate information directly from your own files.
- [AI Functions: Connect Agents to External APIs and Flows](https://docs.theomnibot.io/ai-agents/functions.md): Create AI Functions to let your AI Agents collect data, trigger automation flows, and call external APIs mid-conversation without breaking the chat flow.
- [MCP Servers: Connect AI Agents to External Platforms](https://docs.theomnibot.io/ai-agents/mcp-servers.md): Use the Model Context Protocol to connect your AI Agents to Shopify, Stripe, Zapier, and other external platforms without custom API integrations.
- [Rich Responses: Cards, Carousels, and Automated Actions](https://docs.theomnibot.io/ai-agents/rich-responses.md): Enable AI Agents to send interactive cards, carousels, and quick replies, and execute automated actions like tagging contacts or triggering flows.
- [Managing Your Inbox Conversations Across Every Channel](https://docs.theomnibot.io/inbox/conversations.md): Learn how to filter, transfer, pin, archive, and reply to conversations in ChatbotX Inbox where all channel messages flow into one place.
- [Team Collaboration and Chat Assignment in ChatbotX Inbox](https://docs.theomnibot.io/inbox/team-collaboration.md): Set up Inbox teams, assign conversations manually or automatically, and handle cases where no agents are available using Auto Assign in ChatbotX.
- [Contacts Overview: Manage and Review Your Customer List](https://docs.theomnibot.io/contacts/overview.md): Explore the Contacts page in ChatbotX — search, review, and manage every customer who has interacted with your chatbot across all connected channels.
- [Import Contacts into ChatbotX Using a CSV File Upload](https://docs.theomnibot.io/contacts/import-contacts.md): Bring an existing customer list into ChatbotX by uploading a CSV file, mapping columns to contact fields, and applying tags or custom fields on import.
- [Filter, Bulk Actions, and Export Contacts in ChatbotX](https://docs.theomnibot.io/contacts/filter-and-bulk-actions.md): Filter contacts with advanced conditions, apply bulk actions like Assign and Add Tag to many contacts at once, and export your list to CSV.
- [Broadcasts: Send Bulk Campaigns Across All Channels](https://docs.theomnibot.io/remarketing/broadcasts.md): Send bulk campaigns across Messenger, WhatsApp, and more in ChatbotX — schedule messages, filter your audience, and track delivery and click metrics.
- [Sequences: Schedule Automated Message Series Over Time](https://docs.theomnibot.io/remarketing/sequences.md): Schedule automated message series in ChatbotX to welcome, nurture, and follow up with customers over time while respecting Messenger and WhatsApp policies.
- [Entry Point Links: Send Customers Into Specific Flows](https://docs.theomnibot.io/tools/entry-point-links.md): Create Entry Point Links (Reflinks) to drop customers directly into the right chatbot Flow the moment they click, across every connected channel.
- [Comment Automation: Auto-Reply on Facebook and Instagram](https://docs.theomnibot.io/tools/comment-automation.md): Automate public and private replies to Facebook and Instagram comments, protect customer data, filter keywords, and track campaign performance.
- [Questionnaires: Collect and Validate User Responses](https://docs.theomnibot.io/tools/questionnaires.md): Build multi-question sequences inside a Flow to collect, validate, and score user responses, then review results in the Applicants dashboard.
- [Magic Links: Smart Tracking URLs with Dynamic Parameters](https://docs.theomnibot.io/tools/magic-links.md): Create trackable deep links that capture query string parameters dynamically and redirect users to Messenger, WhatsApp, Telegram, or any destination URL.
- [Coupons: Distribute and Track Unique Discount Codes](https://docs.theomnibot.io/tools/coupons.md): Create Topic Coupons, import discount codes in bulk, assign unique codes to customers in a Flow, and track assignment and usage across your contacts.
- [Integrations Overview: Connect ChatbotX to Your Stack](https://docs.theomnibot.io/integrations/overview.md): Connect ChatbotX to Google Sheets, Make, ActiveCampaign, Mailchimp, Klaviyo, and more to sync data, automate workflows, and grow your contact lists.
- [Google Sheets Integration: Sync and Manage Data in Flows](https://docs.theomnibot.io/integrations/google-sheets.md): Connect ChatbotX to Google Sheets to send, retrieve, update, and clear spreadsheet rows automatically from inside your conversation Flows.
- [Make Integration: Connect ChatbotX to External Apps](https://docs.theomnibot.io/integrations/make.md): Connect ChatbotX to Make via the ChatConnectX app to trigger scenarios from Flows, manage contacts, and send messages or Flows from Make scenarios.
- [Webhooks: Send Contact Data to External Applications](https://docs.theomnibot.io/integrations/webhooks.md): Configure Webhooks to send an HTTP POST payload to any external URL when a specific action occurs inside a Perform Action node in Flow Builder.
- [Analytics: Monitor Your Chatbot and Team Performance](https://docs.theomnibot.io/analytics.md): Track contact growth, bot performance, human agent response times, conversation distribution, and contact sources in ChatbotX's Analytics reporting hub.
- [White Label: Run the Full ChatbotX Platform Under Your Brand](https://docs.theomnibot.io/whitelabel/overview.md): Configure ChatbotX's White Label feature to deliver chatbot, Inbox, and AI Agent services to clients under your own domain, logo, and brand colors.
- [White Label Branding, Custom Domain, and SMTP Setup](https://docs.theomnibot.io/whitelabel/branding.md): Configure brand name, logos, favicon, theme color, custom domain with SSL, SMTP email delivery, and branded email templates for your white-label portal.
- [SaaS Management: Accounts, Plans, Billing, and Quotas](https://docs.theomnibot.io/whitelabel/saas-management.md): Manage sub-accounts, configure pricing plans with resource quotas, connect Stripe for automated billing, and share channel app credentials with clients.
- [ChatbotX CLI: Terminal Access for Your ChatbotX Workspace](https://docs.theomnibot.io/cli/introduction.md): Install and authenticate the ChatbotX CLI to run exact API operations, automate tasks, and integrate ChatbotX into scripts and cronjobs.
- [ChatbotX CLI Command Reference: All Commands and Flags](https://docs.theomnibot.io/cli/command-reference.md): Complete reference for every ChatbotX CLI command group: config, workspaces, contacts, tags, custom fields, flows, sequences, channels, and more.
- [ChatbotX MCP Server: AI-Powered Workspace Automation](https://docs.theomnibot.io/mcp/introduction.md): Connect AI assistants to your ChatbotX Workspace via the Model Context Protocol. Query contacts, send messages, and trigger flows using natural language.
- [ChatbotX MCP Platform Setup Guide for AI Assistants](https://docs.theomnibot.io/mcp/platform-setup.md): Step-by-step instructions for connecting ChatbotX MCP to OpenClaw, Hermes, Claude Code, VS Code, Gemini CLI, and ChatGPT Developer Mode.
- [ChatbotX REST API — Overview and Authentication](https://docs.theomnibot.io/api-reference/overview.md): Authenticate with the ChatbotX API using Bearer tokens, review base URLs for cloud and self-hosted instances, and explore all available resource endpoints.
- [List Contacts: Paginate and Filter Your Workspace](https://docs.theomnibot.io/api-reference/contacts/list-contacts.md): Retrieve a paginated list of contacts from your ChatbotX Workspace with optional keyword search, channel filters, inbox filters, and custom sort orders.
- [Create Contact: Add a New Contact to Your Workspace](https://docs.theomnibot.io/api-reference/contacts/create-contact.md): Use POST /api/v1/contacts to add a new contact to your ChatbotX Workspace with a phone number, email address, gender, and optional name fields.
- [Get Contact by Identifier: ID, Email, or Phone](https://docs.theomnibot.io/api-reference/contacts/get-contact.md): Use GET /api/v1/contacts/{identifier} to retrieve a single contact from your ChatbotX Workspace by internal ID, email address, or phone number.
- [Update Contact: Modify an Existing Contact's Fields](https://docs.theomnibot.io/api-reference/contacts/update-contact.md): Use PUT /api/v1/contacts/{identifier} to update profile fields on an existing ChatbotX contact, identified by internal ID, email, or phone number.
- [Delete Contact: Permanently Remove a Contact Record](https://docs.theomnibot.io/api-reference/contacts/delete-contact.md): Permanently delete a contact from your ChatbotX Workspace using their internal ID, email address, or phone number as the identifier.
- [Upsert Contact: Create or Update by Identifier](https://docs.theomnibot.io/api-reference/contacts/upsert-contact.md): Create a new contact or update an existing one in ChatbotX using a flexible identifier. Ideal for syncing contacts from external CRM systems.
- [Import Contacts: Bulk Import from an Uploaded File](https://docs.theomnibot.io/api-reference/contacts/import-contacts.md): Bulk import contacts into ChatbotX from a previously uploaded file, mapping CSV columns to contact fields and assigning a channel, inbox, and optional tag.
- [Send Message to Contact on Any Active Channel](https://docs.theomnibot.io/api-reference/contacts/send-message.md): Use POST /api/v1/contacts/{identifier}/messages to send a text, file, or flow message to a contact on their active ChatbotX channel inbox.
- [Send Flow to Contact: Trigger Automation for a Contact](https://docs.theomnibot.io/api-reference/contacts/send-flow.md): Trigger a ChatbotX automation flow for a specific contact, optionally targeting a particular inbox channel for the flow execution.
- [Contact Tags: Add, Remove, and List Contact Tags](https://docs.theomnibot.io/api-reference/contacts/tags.md): Manage tags on a ChatbotX contact with three endpoints: add tags to a contact, remove tags from a contact, and list all tags currently applied.
- [Contact Custom Fields: Read and Write Custom Data](https://docs.theomnibot.io/api-reference/contacts/custom-fields.md): Use GET and POST on /api/v1/contacts/{identifier}/custom-fields to retrieve all custom field values or set a single field value on a ChatbotX contact.
- [List All Contact Custom Fields via the ChatbotX API](https://docs.theomnibot.io/api-reference/custom-fields/list.md): Use GET /api/v1/custom-fields to retrieve all custom field definitions in your ChatbotX workspace, with optional keyword filtering to narrow results.
- [Create a Contact Custom Field via the ChatbotX API](https://docs.theomnibot.io/api-reference/custom-fields/create.md): Use POST /api/v1/custom-fields to add a new custom field to your ChatbotX workspace. Provide a unique name and a data type such as shortText or date.
- [Update a Contact Custom Field via the ChatbotX API](https://docs.theomnibot.io/api-reference/custom-fields/update.md): Use PUT /api/v1/custom-fields/{id} to rename a custom field, update its description, or move it to a different folder in your ChatbotX workspace.
- [Delete a Contact Custom Field via the ChatbotX API](https://docs.theomnibot.io/api-reference/custom-fields/delete.md): Use DELETE /api/v1/custom-fields/{id} to permanently remove a custom field from your ChatbotX workspace. All stored contact values are also deleted.
- [List All Contact Tags via the ChatbotX REST API](https://docs.theomnibot.io/api-reference/tags/list.md): Use GET /api/v1/tags to retrieve a paginated list of all tags in your ChatbotX workspace, with optional keyword filtering to find specific tags quickly.
- [Create a New Contact Tag via the ChatbotX REST API](https://docs.theomnibot.io/api-reference/tags/create.md): Use POST /api/v1/tags to create a new contact tag in your ChatbotX workspace by supplying a unique name and an optional folder assignment.
- [Update an Existing Contact Tag via the ChatbotX API](https://docs.theomnibot.io/api-reference/tags/update.md): Use PUT /api/v1/tags/{id} to rename an existing tag in your ChatbotX workspace. Supply the tag's numeric ID and the new name in the request body.
- [Delete a Contact Tag via the ChatbotX REST API](https://docs.theomnibot.io/api-reference/tags/delete.md): Permanently delete a tag from your ChatbotX workspace by its unique ID. Contacts that held the tag will no longer have it assigned.
- [List All Automation Flows via the ChatbotX REST API](https://docs.theomnibot.io/api-reference/flows/list.md): Retrieve a paginated list of all automation flows in your ChatbotX workspace, with optional keyword search to locate specific flows.
- [List All Message Sequences via the ChatbotX REST API](https://docs.theomnibot.io/api-reference/sequences/list.md): Retrieve a paginated list of all message sequences in your ChatbotX workspace, including subscriber counts and engagement metrics.
- [Get Message Sequence Details via the ChatbotX API](https://docs.theomnibot.io/api-reference/sequences/get.md): Use GET /api/v1/sequences/{id} to retrieve full details, engagement metrics, and configuration for a single message sequence in your ChatbotX workspace.
- [List All Broadcasts — ChatbotX REST API Reference](https://docs.theomnibot.io/api-reference/broadcasts/list.md): Use GET /api/v1/broadcasts to list all broadcasts in your ChatbotX workspace, including scheduling details and contact reach counts.
- [Get a Broadcast by ID or Name via the ChatbotX API](https://docs.theomnibot.io/api-reference/broadcasts/get.md): Use GET /api/v1/broadcasts/{idOrName} to retrieve full details for a single ChatbotX broadcast by ID or name, including status and scheduling information.
- [List Connected Channels via the ChatbotX REST API](https://docs.theomnibot.io/api-reference/channels/list.md): Use GET /api/v1/channels to list all connected messaging channels in your ChatbotX workspace, including the channel type and current connection status.
- [Get Your Workspace Details via the ChatbotX REST API](https://docs.theomnibot.io/api-reference/workspace/get.md): Retrieve the full configuration details for your ChatbotX workspace, including name, timezone, brand settings, and owner information.
- [List and Retrieve Workspace Members via ChatbotX API](https://docs.theomnibot.io/api-reference/workspace/members.md): List all members in your ChatbotX workspace or retrieve a single member by ID, including their role, permissions, and profile details.
- [List Workspace Agent Teams via the ChatbotX REST API](https://docs.theomnibot.io/api-reference/workspace/teams.md): Use GET /api/v1/teams to retrieve all agent teams in your ChatbotX workspace, including each team's name, membership list, and user profile details.
- [List AI Agents in Your Workspace — ChatbotX REST API](https://docs.theomnibot.io/api-reference/ai-agents/list.md): Use GET /api/v1/ai-agents to list all AI agents configured in your ChatbotX workspace, including model settings, system prompts, and enabled tools.