# Chatarmin CX Docs

## Guides

### Get started

- [Introduction](https://docs.armin.cx/introduction.md): Learn how Chatarmin CX brings tickets, channels, AI Agents, and integrations into one support workspace.
- [Quickstart](https://docs.armin.cx/quickstart.md): Connect your support operation and launch your first AI Agent.
- [Ask Torben](https://docs.armin.cx/ask-torben.md): Create and improve AI Agents, diagnose support, and get product help.
- [Changelog](https://docs.armin.cx/changelog.md): Latest product updates and new features

### Dashboard

- [Dashboard](https://docs.armin.cx/dashboard/intro.md): Build and share dashboards for the support metrics that matter to your team.
- [How metrics are calculated](https://docs.armin.cx/dashboard/metrics.md): Understand the definitions, timing, date ranges, and exclusions behind dashboard metrics.

### Inbox

- [Inbox](https://docs.armin.cx/inbox/intro.md): Use the inbox to manage every customer conversation from one place.
- [Tickets](https://docs.armin.cx/inbox/tickets.md): Work with customer conversations, AI drafts, status, assignment, and ticket actions.
- [Views and filters](https://docs.armin.cx/inbox/views-and-filters.md): Create saved inbox views for teams, channels, tags, and ticket fields.
- [Tags](https://docs.armin.cx/inbox/tags.md): Use tags to classify tickets, build views, and route work.
- [Auto-tagging](https://docs.armin.cx/inbox/auto-tagging.md): Configure automatic tag matching from native tag settings.
- [Auto resolve](https://docs.armin.cx/inbox/auto-solve.md): Resolve low-value tickets automatically while keeping a review path.
- [SLAs](https://docs.armin.cx/inbox/slas.md): Apply response-time targets to tickets and surface breaches in the inbox.
- [Spam](https://docs.armin.cx/inbox/spam.md): Detect, tag, resolve, and block spam before it clutters the inbox.
- [Attachment and link security](https://docs.armin.cx/inbox/attachment-security.md): Dangerous attachments are quarantined, disguised links are disabled, and affected tickets are flagged before anyone opens them.
- [Side conversations](https://docs.armin.cx/inbox/side-conversations.md): Start email side conversations from a ticket to coordinate with suppliers, carriers, or partners.
- [Macros](https://docs.armin.cx/macros/intro.md): Create reusable replies for faster, more consistent customer support.
- [Ticket Fields](https://docs.armin.cx/ticket-fields/intro.md): Capture structured data with custom fields and AI-powered auto-population

### Rules

- [Rules](https://docs.armin.cx/rules/intro.md): Create simple When/Then automations for routing, tags, status, and assignment.

### AI Agents

- [AI Agents](https://docs.armin.cx/ai-agents/intro.md): Automate customer support tickets from first request to resolution.
- [Getting started](https://docs.armin.cx/ai-agents/getting-started.md): Create, test, and activate your first AI Agent.
- [AI credits](https://docs.armin.cx/ai-agents/ai-credits.md): Understand AI Agent usage and see the credits used for common support jobs.
- [Email sender exclusions](https://docs.armin.cx/ai-agents/email-sender-exclusions.md): Keep email from selected senders human-only by preventing automatic AI replies and AI Agent work.
- [Triggers and filters](https://docs.armin.cx/ai-agents/triggers-and-filters.md): Start AI Agents on new tickets or after a delay, then match the right support work with an AI trigger by default.
- [Routing and ownership](https://docs.armin.cx/ai-agents/routing-and-ownership.md): Understand which automation owns a customer conversation.
- [Router and specialists](https://docs.armin.cx/ai-agents/router-and-specialists.md): Build one clear entry agent with focused specialists.
- [Subagents](https://docs.armin.cx/ai-agents/subagents.md): Let one agent consult focused specialists.
- [Skills and actions](https://docs.armin.cx/ai-agents/skills-and-actions.md): Give AI Agents the knowledge, systems, and permissions they need.
- [Human in the loop](https://docs.armin.cx/ai-agents/human-in-the-loop.md): Keep a person in control of sensitive replies and business changes with approval safeguards.
- [Activate an AI Agent](https://docs.armin.cx/ai-agents/activate.md): Turn an AI Agent on, keep it manual-only, or pause it without losing its setup.
- [Run on existing tickets](https://docs.armin.cx/ai-agents/run-on-existing-tickets.md): Assign an AI Agent to open tickets one by one or in bulk so it can work your backlog.
- [Testing and run history](https://docs.armin.cx/ai-agents/testing-and-runs.md): Test AI Agents before launch and inspect what happened after each run.
- [Examples](https://docs.armin.cx/ai-agents/examples.md): Launch AI Agents for common customer-support jobs.
- [Replace Classic AI](https://docs.armin.cx/ai-agents/migrate-from-classic-ai.md): Rebuild legacy Classic AI behavior with an AI Agent.
- [Replace Workflows](https://docs.armin.cx/ai-agents/migrate-workflows.md): Rebuild legacy Workflow automation with AI Agents.

### Channels

- [Channels overview](https://docs.armin.cx/channels/overview.md): Connect customer channels and route every conversation into the inbox.
- [Email](https://docs.armin.cx/channels/email/intro.md): Forward support emails into Chatarmin CX and send replies from your address.
- [Sender avatars in customer inboxes](https://docs.armin.cx/channels/email/sender-avatars.md): Show a logo or profile photo next to your support emails in Gmail and other inboxes.
- [WhatsApp](https://docs.armin.cx/channels/whatsapp/whatsapp.md): Connect ChatArmin WhatsApp conversations to the Chatarmin CX inbox and verify forwarding.
- [Contact forms](https://docs.armin.cx/channels/contact-form/intro.md): Embed forms on your website and turn submissions into tickets.
- [Web widget](https://docs.armin.cx/channels/web/intro.md): Add website chat with AI assistance and human handover.
- [Social media channels](https://docs.armin.cx/channels/socialmedia/intro.md): Route social conversations into the inbox and resolve low-value messages automatically.
- [Voice](https://docs.armin.cx/channels/voice/intro.md): Set up an AI voice assistant for phone support.
- [Reviews.io](https://docs.armin.cx/channels/reviews.md): Send Reviews.io feedback into the inbox as tickets.
- [eTrusted](https://docs.armin.cx/channels/etrusted.md): Manage Trusted Shops reviews from the Chatarmin CX inbox.

### Integrations

- [Integrations](https://docs.armin.cx/integrations/intro.md): Connect the business systems your team and AI Agents use.
- [Asana](https://docs.armin.cx/integrations/asana.md): Use Asana actions to create and route follow-up tasks from Chatarmin CX.
- [Billbee](https://docs.armin.cx/integrations/billbee.md): Retrieve Billbee orders, invoices, and shipping details from Chatarmin CX.
- [Chatarmin](https://docs.armin.cx/integrations/chatarmin.md): Forward ChatArmin WhatsApp conversations into Chatarmin CX.
- [DHL](https://docs.armin.cx/integrations/dhl.md): Retrieve DHL tracking information for AI Agent replies.
- [FFN Connect / Fly](https://docs.armin.cx/integrations/ffn-connect.md): Automate cancellations and order changes when FFN Connect syncs Shopify to your warehouse — without a native FFN action.
- [Gorgias](https://docs.armin.cx/integrations/gorgias.md): Sync Gorgias helpdesk data into Chatarmin CX.
- [Hive](https://docs.armin.cx/integrations/hive.md): Show Hive fulfillment orders in the inbox and let AI Agents look up, hold, cancel, and update orders.
- [JTL Wawi (API)](https://docs.armin.cx/integrations/jtl-wawi.md): Connect JTL-Wawi securely for order lookup and approved write actions.
- [Klaviyo](https://docs.armin.cx/integrations/klaviyo.md): Connect Klaviyo to Chatarmin CX.
- [Klarna](https://docs.armin.cx/integrations/klarna.md): Manage Klarna payment disputes from the inbox while you help the customer on the same ticket.
- [Monta](https://docs.armin.cx/integrations/monta.md): Use Monta fulfillment data and control warehouse-side order changes safely.
- [Odoo](https://docs.armin.cx/integrations/odoo.md): Use Odoo order, invoice, and customer data in tickets and AI Agents.
- [PayPal](https://docs.armin.cx/integrations/paypal.md): View and resolve PayPal disputes from the inbox customer panel and with AI Agents.
- [PlentyOne](https://docs.armin.cx/integrations/plentyone.md): Use PlentyOne order and invoice data in tickets and AI Agents.
- [Returnista](https://docs.armin.cx/integrations/returnista.md): Retrieve return information from Returnista in AI Agent actions.
- [Sage 100](https://docs.armin.cx/integrations/sage.md): Connect a customer-specific Sage 100 interface to Chatarmin CX.
- [SAP](https://docs.armin.cx/integrations/sap.md): Connect SAP business data to Chatarmin CX.
- [Shopify](https://docs.armin.cx/integrations/shopify.md): Use Shopify order data and run order actions safely from CX.
- [Shopware](https://docs.armin.cx/integrations/shopware.md): Use Shopware order data in AI Agent actions and ticket replies.
- [Trengo](https://docs.armin.cx/integrations/trengo.md): Sync Trengo helpdesk data into Chatarmin CX.
- [WooCommerce](https://docs.armin.cx/integrations/woocommerce.md): Show WooCommerce customer and order data in tickets.
- [Xentral](https://docs.armin.cx/integrations/xentral.md): Use Xentral ERP data in tickets and AI Agents.

#### Ticket import

- [Ticket import](https://docs.armin.cx/integrations/ticket-import/intro.md): Migrate historical tickets into Chatarmin CX from Crisp, Zendesk, Freshdesk, Front, Gorgias, and WhatsApp.
- [Crisp](https://docs.armin.cx/integrations/ticket-import/crisp.md): Import Crisp conversations and macros into Chatarmin CX.
- [Zendesk](https://docs.armin.cx/integrations/ticket-import/zendesk.md): Import Zendesk tickets into Chatarmin CX from JSON exports or the migration wizard.
- [Freshdesk](https://docs.armin.cx/integrations/ticket-import/freshdesk.md): Import Freshdesk tickets and macros into Chatarmin CX.
- [Front](https://docs.armin.cx/integrations/ticket-import/front.md): Import Front conversations into Chatarmin CX from Messages CSV exports.
- [Gorgias](https://docs.armin.cx/integrations/ticket-import/gorgias.md): Run a one-time historical Gorgias migration into Chatarmin CX.
- [WhatsApp (iMazing)](https://docs.armin.cx/integrations/ticket-import/whatsapp-imazing.md): Import historic WhatsApp conversations from iMazing CSV exports into Chatarmin CX.

### Settings

- [Settings sitemap](https://docs.armin.cx/settings/sitemap.md): Find common workspace, channel, AI Agent, inbox, and integration settings.
- [Roles and permissions](https://docs.armin.cx/settings/roles-and-permissions.md): Assign Admin, Support, or Basic roles and control channel and dashboard access.
- [Billing](https://docs.armin.cx/settings/billing.md): Manage your plan, payment details, and invoices in Chatarmin CX.
- [AI disclosure (EU AI Act)](https://docs.armin.cx/settings/ai-disclosure.md): Add a short AI notice to automated replies so customers know they are talking to AI.
- [Customer data deletion (GDPR)](https://docs.armin.cx/settings/customer-data-deletion.md): Review, verify, and permanently delete customer data from cx.

### Troubleshooting

- [Email missing or wrong contact](https://docs.armin.cx/troubleshooting/email-ingestion.md): Check forwarding, sender, recipient, and channel settings for email ingestion issues.
- [Take over from AI](https://docs.armin.cx/troubleshooting/take-over-from-ai.md): Keep a customer conversation with the human team.
- [Notification not received](https://docs.armin.cx/troubleshooting/notification-not-received.md): Collect the details needed to debug missing email, Slack, browser, and in-app notifications.
- [External helpdesk sync](https://docs.armin.cx/troubleshooting/external-helpdesk-sync.md): Debug Zendesk, Gorgias, Freshdesk, and other helpdesk sync behavior.
- [Escalating to engineering](https://docs.armin.cx/troubleshooting/escalating-to-engineering.md): Share the right context before Ask Torben involves the product team.

## API

### Public API v1

- [Overview](https://docs.armin.cx/api/overview.md): Ticket read and create API for integrations and AI agent tools.
- [Getting started](https://docs.armin.cx/api/getting-started.md): Create an API key and make your first Public API v1 request.
- [Authentication & API keys](https://docs.armin.cx/api/authentication.md): Authenticate with cx-api-key, scopes, and least-privilege keys for agents.
- [Rate limits](https://docs.armin.cx/api/rate-limits.md): Per-route rate limits, response headers, and backoff guidance.
- [Filtering & saved views](https://docs.armin.cx/api/filtering-and-saved-views.md): Filter tickets with view_id and saved inbox views — no ad-hoc query params in v1.
- [Pagination](https://docs.armin.cx/api/pagination.md): Cursor-based pagination for ticket, view, and message lists.
- [Errors](https://docs.armin.cx/api/errors.md): Structured error envelopes, machine-readable codes, and HTTP status mapping.
- [Agent tool examples](https://docs.armin.cx/api/agent-tool-examples.md): Map common AI agent tasks to Public API v1 endpoints and tool definitions.
- [Create a ticket](https://docs.armin.cx/api/create-ticket.md): Create support tickets via POST /public/v1/tickets.
- [Reports and metrics](https://docs.armin.cx/api/reports.md): Discover support metrics and query report data with the Public API v1.
- [Migrating from legacy /public](https://docs.armin.cx/api/v1/migration.md): Move from deprecated /public/* endpoints to /public/v1 with envelope, pagination, and scope changes.

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [German (96 pages)](https://docs.armin.cx/_llms/de.md): Documentation for German.