# NeuronCx

- [NeuronCx AI: Omnichannel Automations & Reasoning](https://docs.neuroncx.in/introduction.md): NeuronCx automates conversations, qualifies leads, and orchestrates every customer interaction — across WhatsApp, email, telephony, and web — from one unified dashboard.
- [Navigate the Neuroncx AI Dashboard](https://docs.neuroncx.in/getting-started/dashboard-overview.md): Monitor conversations, campaign delivery, trending topics, workflow execution, and system health in real time from the Neuroncx AI unified dashboard.
- [Document Console](https://docs.neuroncx.in/getting-started/prescription-tab.md): How clinicians and technicians review, edit, and confirm NeuronCx's auto-parsed prescription tests before sending them back to the diagnostic centre.
- [Manage Leads in the Transactions Console](https://docs.neuroncx.in/getting-started/transactions-console.md): Search, filter, and work individual leads in the Transactions Console — from first contact through verification, status updates, and saving your changes.
- [Payment failed](https://docs.neuroncx.in/transaction-console/payments/payment-failed.md): Understand payment order statuses in the Transactions Console and learn how to investigate failed payments.
- [Panel Analytics](https://docs.neuroncx.in/transactions-console/panel-analytics.md): A weekly, AI-written performance summary for each agent, shown directly on their record.
- [Walk-in Referrals](https://docs.neuroncx.in/untitled-page.md): Configure a new walk-in referral source and add a walk-in lead directly from the Transactions Console.
- [Support ](https://docs.neuroncx.in/tramsactions-console/support.md): Common how-to questions for the Transaction Console — lead number changes and other topics as they're added.
- [Monitor App Performance and Workflow Execution Metrics](https://docs.neuroncx.in/getting-started/apps-and-workflow-usage.md): Learn how to read the WhatsApp funnel, track workflow execution counts, and manage app versions to optimize your automation performance.
- [Channels Dashboard: Multi-Channel Performance Overview](https://docs.neuroncx.in/getting-started/channels-overview.md): Monitor booking outcomes, patient source attribution, agent-created leads, and topical usage across all active communication channels from one dashboard.
- [WhatsApp Channel: Setup, Flows, and Monitoring](https://docs.neuroncx.in/getting-started/channels/whatsapp.md): Configure your WhatsApp business number, manage message types and templates, and track rate limits, quality errors, and topical intent performance.
- [Email Channel: Campaigns, Follow-Ups, and Notifications](https://docs.neuroncx.in/getting-started/channels/email.md): Use the Email channel to send campaign messages, automated follow-ups, and appointment notifications — all tracked alongside your other channels in Neuroncx AI.
- [Telephony Channel: Voice Calls and Lead Stage Management](https://docs.neuroncx.in/getting-started/channels/telephony.md): Enable outbound voice call workflows, process call transcriptions through the LLM pipeline, and update lead stages directly from the Transactions Console.
- [Web View Channel: Embedded Chat for Your Website](https://docs.neuroncx.in/getting-started/channels/web-view.md): Embed a browser-based chat interface on your hospital or clinic website and capture patient leads directly into the Neuroncx AI Transactions Console.
- [Imports: Bulk Loading Leads and Contact Records](https://docs.neuroncx.in/getting-started/channels/imports.md): Seed the Transactions Console with existing patient or prospect data, migrate records from other CRMs, and make imported leads immediately available for workflows.
- [Channel Settings: Configure Per-Channel Behaviour](https://docs.neuroncx.in/getting-started/channels/settings.md): Manage identifiers, active status, template assignments, notification preferences, and third-party integrations for each channel in your Neuroncx AI account.
- [Setup](https://docs.neuroncx.in/assessment/setup.md): Configure skills, forms, schema, agents, and workflow to get a new assessment running end to end.
- [Monitor](https://docs.neuroncx.in/assessment/monitor.md): Track live assessment coverage and scores from the Cx Ops dashboard — how much call volume has been evaluated, and how it's trending.
- [Audit](https://docs.neuroncx.in/assessment/audit.md): Drill into a single call's evaluation in detail — transcript, evidence snippets, and per-parameter scoring.
- [Analyse](https://docs.neuroncx.in/assessment/analyse.md): Break down agent performance by skill dimension and sub-parameter to spot coaching opportunities and performance trends.
- [Glossary](https://docs.neuroncx.in/assessment/glossary.md): Key terms used across assessment setup, scoring, and auditing.
- [Untitled page 21](https://docs.neuroncx.in/untitled-page-21.md): Link an agent to a Smartflow attribution rule using their External ID, or remove one, from the Supervisor Console.
- [Review Eval Flags on Conversations](https://docs.neuroncx.in/untitled-page-22.md): Find the conversations where the bot's reply had a problem, and mark the flags you have dealt with.
- [Set Up Your Institution's Eval Flags](https://docs.neuroncx.in/untitled-page-23.md): Choose which eval flags your institution uses, add your own, and change or switch them off.
- [Track Agent SLAs](https://docs.neuroncx.in/read-the-sla-page.md): See how quickly and how well your agents respond, and find the calls, leads and bookings that missed the limit.
- [Set Up SLA Rules, Cards and Tabs](https://docs.neuroncx.in/set-up-sla-rules.md): Choose the limits your agents are measured against, and the cards and tabs your SLA page shows.
- [Overview](https://docs.neuroncx.in/data-and-reports/overview.md): Query, visualise, and export platform activity data across domains and date ranges.
- [Query Builder](https://docs.neuroncx.in/data-and-reports/query-builder.md)
- [Fetching Data](https://docs.neuroncx.in/data-and-reports/fetching-data.md)
- [Transaction Source Analysis: Channels, Referrals, and UTM Tags](https://docs.neuroncx.in/data-and-reports/transactions.md): Break down lead generation by source channel, analyze secondary source overlap, trace referral origins, and attribute conversions through UTM parameters.
- [Overview](https://docs.neuroncx.in/overview-2.md): View payment attempts, collections, success rates, and failures across your organisation by date range, grouping, and filter.
- [Comparing Reports](https://docs.neuroncx.in/comparing-reports.md): Run two payment data sets side by side using a second filter or an automatic previous period comparison.
- [See How Many Contacts Each Channel Brings with Channel Analytics](https://docs.neuroncx.in/channel-analytics.md): Count the phone calls, WhatsApp conversations and walk-ins in a date range, split them by channel, source or branch, and export the list behind every number.
- [Managing Your AI Knowledge Base with the Ontology Console](https://docs.neuroncx.in/ontology/overview.md): Explore the Ontology dashboard to audit indexed content libraries, classify assets, identify coverage gaps, and map response templates to conversation topics.
- [Overview](https://docs.neuroncx.in/imports/overview.md): Imports let you bring data into NeuronCx from a Google Sheet — new leads, product and category records, customer identities from another system, and values tied to those identities.
- [Leads Import (Type 1)](https://docs.neuroncx.in/untitled-page-3.md): Bring in new leads from a Google Sheet — creating a user, transaction, and conversation for each row.
- [ProductLine (Type 2)](https://docs.neuroncx.in/untitled-page-4.md): Bulk-import product line records into NeuronCx from a Google Sheet using a simple Id and Value format.
- [CategoryType Import (Type 3)](https://docs.neuroncx.in/untitled-page-5.md): Bulk-import category type records into NeuronCx from a Google Sheet using a simple Id and Value format.
- [Category Import (Type 4)](https://docs.neuroncx.in/untitled-page-6.md): Bulk-import category records into NeuronCx from a Google Sheet using a simple Id and Value format.
- [SKU Import (Type 5)](https://docs.neuroncx.in/untitled-page-10.md): Bulk-import SKU records into NeuronCx from a Google Sheet using a simple Id and Value format.
- [SubCategory Import (Type 6)](https://docs.neuroncx.in/untitled-page-7.md): Bulk-import subcategory records into NeuronCx from a Google Sheet using a simple Id and Value format.
- [Bulk WF Trigger (Type 7)](https://docs.neuroncx.in/untitled-page-8.md): Manually trigger a workflow in bulk for a set of records directly from the NeuronCx dashboard.
- [Trx Attribute Datastore Value Update or Import (Type 8)](https://docs.neuroncx.in/untitled-page-9.md): Update or add attribute datastore values for existing records in NeuronCx from a Google Sheet.
- [Attribute And Post Content Create Using Inline Text (Type 9)](https://docs.neuroncx.in/untitled-page-11.md): Import attribute values from a Google Sheet and automatically create indexed post content using inline text and a treatment.
- [LocationList Import (Type 10)](https://docs.neuroncx.in/untitled-page-12.md): Bulk-import location list records into NeuronCx from a Google Sheet using a simple Id and Value format.
- [Trx Attribute Entity Import (Type 11)](https://docs.neuroncx.in/untitled-page-13.md): Create new attribute entity records in NeuronCx in bulk from a Google Sheet.
- [Trx Attribute Entity Relational Import Update (Type 13)](https://docs.neuroncx.in/untitled-page-14.md): Update existing entity records and their relationships to other entities in NeuronCx from a Google Sheet.
- [Updating Post-Content from Trx Attribute (Type 16)](https://docs.neuroncx.in/untitled-page-15.md): Update post content in NeuronCx with transaction attribute data, properties, and relations from a Google Sheet.
- [Call Analytics WF Import (Type 17)](https://docs.neuroncx.in/untitled-page-16.md): Import call recordings in bulk for assessment by uploading a Google Sheet with agent and recording details.
- [WF Trigger with Sheet Supplied Initial Variable (Type 19)](https://docs.neuroncx.in/untitled-page-17.md): Trigger a workflow for each row in a Google Sheet, using a date and user mobile number as the input variables.
- [Post Content Update (Type 20)](https://docs.neuroncx.in/untitled-page-18.md): Append new text to existing post content and regenerate its embedding.
- [Lead Import With Attributes (Type 23)](https://docs.neuroncx.in/untitled-page-19.md): Bulk-import treatment-specific attribute data onto an existing transaction, such as an OBG visit history.
- [External Identity Import (Type 24)](https://docs.neuroncx.in/imports/external-identity-import-type-24.md): Match rows in a Google Sheet to existing customer or patient records by phone number, or create new ones.
- [TPS User Parameters Input (Type 25)](https://docs.neuroncx.in/imports/external-values-import-type-25.md): Set attribute values on already-identified customer or patient records from a Google Sheet.
- [Audit the Image Gallery](https://docs.neuroncx.in/image-gallery-auditing.md): Review the images, documents, audio, and videos patients send on WhatsApp, see which lead sent each file, and archive the ones you don't need.
- [Setting Up External Webhooks in Neuroncx AI](https://docs.neuroncx.in/getting-started/integrations/external-webhooks.md): Learn how to create and configure external webhooks to push real-time transaction events from Neuroncx AI to your external systems and services.
- [Connecting Third-Party APIs and External Services](https://docs.neuroncx.in/getting-started/integrations/third-party-apis.md): Configure API integrations between Neuroncx AI and your CRMs, Hospital Information Systems, payment gateways, and other external platforms to automate data flow.
- [Audience and Campaigns](https://docs.neuroncx.in/getting-started/audience-insights.md): Explore how Neuroncx AI clusters your users, surfaces trending topics, and measures topic qualification to help you target and engage more effectively.
- [Admin Console Configuration Guide for Neuroncx AI](https://docs.neuroncx.in/getting-started/admin-console.md): Explore every Admin Console component in Neuroncx AI — clusters, triggers, integrations, cron tasks, schedules, data lakes, alerts, flags, and system initialisation.
- [Troubleshooting Common Neuroncx AI Platform Issues](https://docs.neuroncx.in/troubleshooting.md): Step-by-step fixes for login problems, dashboard errors, missing leads, messaging failures, and workflow issues on the Neuroncx AI platform.
- [Neuroncx AI Frequently Asked Questions](https://docs.neuroncx.in/faqs.md): Answers to the most common questions about logging in, managing leads, messaging channels, workflows, and AI configuration on the Neuroncx AI platform.
- [Template Categories](https://docs.neuroncx.in/faq/whatsapp-faq/template-categories.md): Understand the three WhatsApp Business template categories — Utility, Marketing, and Authentication — and when to use each.
- [Navigating Meta Classifiers](https://docs.neuroncx.in/faq/whatsapp-faq/navigating-meta-classifiers.md): Understand how Meta's AI classifier categorises WhatsApp templates and how to avoid common rejection triggers.
- [Push a prospect](https://docs.neuroncx.in/api-reference/prospects/push-prospect.md): Create a new prospect (lead) with optional NCX attributes and Facebook/Google/UTM parameters.
- [Get lead details by lead ID](https://docs.neuroncx.in/api-reference/prospects/get-lead.md): Retrieve the details of a lead by its unique identifier.
- [Send outbound WhatsApp message](https://docs.neuroncx.in/api-reference/messages/send-outbound.md): Wrapper on the WhatsApp Cloud API `/message` endpoint. Supports template (text / media / interactive / authentication) and session (text / image) messages.
- [Inbound simulation (interactive)](https://docs.neuroncx.in/api-reference/messages/inbound-simulation.md): Simulate an inbound WhatsApp interactive / button message webhook payload.
- [Get transaction attribute options](https://docs.neuroncx.in/api-reference/attributes/get-options.md): Fetch child attribute options by passing the master (parent) attribute id and a selected id.
- [Update agent status](https://docs.neuroncx.in/api-reference/agent/update-status.md): Update the status of a chat / agent session.
- [Get agent by number](https://docs.neuroncx.in/api-reference/agent/get-by-number.md): Fetch agent details for a given user mobile number.
- [Event handler (v1)](https://docs.neuroncx.in/api-reference/events/event-handler-v1.md): Handle a booking event for a specific exam.
- [Event handler (v2)](https://docs.neuroncx.in/api-reference/events/event-handler-v2.md): V2 event handler. Also handles prescription events (eventId: 88).

## OpenAPI Specs

- [openapi](https://gist.githubusercontent.com/narcalli/549ca00d8b30e19efd00b0cf93eddc0c/raw/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.