# HaloAgents

> AI-powered customer support agents that know your users, your product, and your data.

## Docs

- [Automatic Ticket Creation](https://docs.haloagents.ai/advanced/automatic-ticket-creation.md): Programmatically create support tickets in Halo from form submissions, applications, or any external system.
- [Planning Your Context Strategy](https://docs.haloagents.ai/advanced/context-planning.md): A step-by-step guide to deciding what data to send, how to structure it, and how to keep it fresh.
- [Identity Verification (JWT)](https://docs.haloagents.ai/advanced/identity-verification.md): Production setup for identity verification — sign JWTs server-side with your Identity Secret to prevent user impersonation.
- [Submitting Tickets from Third-Party Apps](https://docs.haloagents.ai/advanced/third-party-integrations.md): How to send support requests from form builders, CRMs, and external tools into Halo with proper user association.
- [Agent Actions](https://docs.haloagents.ai/agents/actions.md): Wire your agent to integration tools so it can create deals, file bugs, request billing changes, and post to Slack.
- [Agent Channels](https://docs.haloagents.ai/agents/channels.md): Where an agent runs — web widget, email mailbox, Slack workspace, help center.
- [Escalation](https://docs.haloagents.ai/agents/escalation.md): Decide when your agent hands off to a human, who picks up the ticket, and which customers get priority.
- [Agent Instructions](https://docs.haloagents.ai/agents/instructions.md): Write the system prompt that defines your agent's tone, scope, and behavior.
- [Live Train](https://docs.haloagents.ai/agents/live-train.md): Practice and tune your agent in a sandboxed widget without affecting real customers.
- [AI Agents Overview](https://docs.haloagents.ai/agents/overview.md): Agents are configurable AI personas with instructions, skills, channels, and connected tools. Most workspaces have one or two.
- [Agent Skills](https://docs.haloagents.ai/agents/skills.md): Turn on opt-in capabilities your agent can use, web search and UI highlighting and navigation.
- [Voice & Live Help](https://docs.haloagents.ai/agents/voice-and-live-help.md): Add voice-mode chat (ElevenLabs) and a real-time video avatar (HeyGen) to your widget.
- [Chat](https://docs.haloagents.ai/api-reference/chat.md): POST /api/sdk/chat -- Send a message and receive a complete AI response.
- [Chat (Streaming)](https://docs.haloagents.ai/api-reference/chat-stream.md): POST /api/sdk/chat/stream -- Send a message and receive a streaming AI response.
- [Companies](https://docs.haloagents.ai/api-reference/companies.md): POST /api/sdk/companies/identify -- Create or update a company record.
- [Config](https://docs.haloagents.ai/api-reference/config.md): GET /api/sdk/config -- Get the active agent configuration for an organization.
- [Events](https://docs.haloagents.ai/api-reference/events.md): POST /api/sdk/events -- Send behavioral tracking events.
- [API Overview](https://docs.haloagents.ai/api-reference/overview.md): Base URL, authentication, and general information about the HaloAgents REST API.
- [Series](https://docs.haloagents.ai/api-reference/series.md): POST /api/sdk/series -- Enroll or remove users from email series automations.
- [Tickets](https://docs.haloagents.ai/api-reference/tickets.md): POST /api/sdk/tickets/create -- Create a support ticket programmatically.
- [Users](https://docs.haloagents.ai/api-reference/users.md): POST /api/sdk/users/identify -- Create or update an end user record.
- [Update / Backfill Users](https://docs.haloagents.ai/api-reference/users-update.md): POST /api/sdk/users/update -- Bulk-update user traits without affecting activity data.
- [Ask AI](https://docs.haloagents.ai/ask-ai/overview.md): Chat with an AI that has your full HaloAgents account in context. Look up users, query metrics, draft broadcasts, and more, in plain English.
- [AI Builder](https://docs.haloagents.ai/automation/ai-builder.md): Describe a series in plain English and Halo plans, drafts, and lays it out for you, end to end. You review and click Activate.
- [Broadcasts](https://docs.haloagents.ai/automation/broadcasts.md): Send one-time email campaigns to targeted audiences with real-time delivery tracking.
- [In-App Messages & Banners](https://docs.haloagents.ai/automation/in-app-messages.md): Surface contextual messages inside your product without going through email.
- [Automation Overview](https://docs.haloagents.ai/automation/overview.md): Broadcasts, series, in-app messages, and banners. The four ways HaloAgents reaches your customers proactively.
- [Series](https://docs.haloagents.ai/automation/series.md): Multi-step email and in-app sequences with conditions, waits, and branching.
- [Subscription Lists](https://docs.haloagents.ai/automation/subscription-lists.md): Consent management for marketing emails. Opt-in vs opt-out, unsubscribe handling, and CAN-SPAM compliance.
- [Triggers & Conditions](https://docs.haloagents.ai/automation/triggers-and-conditions.md): How series start (entry triggers), who is eligible (audience), how they branch (conditions), and how recipients exit. Mirrors the Series Rules side panel in the dashboard exactly.
- [Troubleshooting](https://docs.haloagents.ai/automation/troubleshooting.md): Why a series shows 0 matched contacts, why enrollment did not happen, and how to verify audience filters against real contact data.
- [Custom Sending Domain](https://docs.haloagents.ai/channels/custom-domain.md): Send emails from your own domain for a professional, branded experience.
- [Email Channel](https://docs.haloagents.ai/channels/email-overview.md): Send and receive customer support emails directly from your HaloAgents inbox.
- [Receiving Emails](https://docs.haloagents.ai/channels/receiving-emails.md): Forward emails from your existing support address into HaloAgents.
- [Sending Settings](https://docs.haloagents.ai/channels/sending-emails.md): Configure how outbound emails appear, set up teammate addresses, and manage AI agent email.
- [Company Traits](https://docs.haloagents.ai/contacts/company-traits.md): Recommended and custom attributes for identifying companies.
- [Context Entries](https://docs.haloagents.ai/contacts/context-entries.md): Deep dive on ContextEntry — the structured, typed data that powers AI-aware support.
- [Examples](https://docs.haloagents.ai/contacts/examples.md): Real-world integration examples showing how to structure data for the AI agent.
- [Health Scores](https://docs.haloagents.ai/contacts/health-scores.md): A 0–100 score per company (or user) computed from activity, support, sentiment, and payment signals.
- [Importing & Backfilling Data](https://docs.haloagents.ai/contacts/importing-data.md): Bring your existing users into Halo, or backfill missing traits, without corrupting activity data.
- [Contacts & Companies Overview](https://docs.haloagents.ai/contacts/overview.md): How user data, company data, and structured context flow through Halo to power the AI.
- [Renewals](https://docs.haloagents.ai/contacts/renewals.md): Track contract terms, renewal dates, and statuses across companies and contacts. Auto-status rules from Stripe and PandaDoc.
- [User Traits](https://docs.haloagents.ai/contacts/user-traits.md): Recommended and custom attributes for identifying end users.
- [How Halo Works](https://docs.haloagents.ai/getting-started/how-it-works.md): The architecture behind Halo: agents, channels, knowledge, context, and how a single user message gets handled end-to-end.
- [Introduction](https://docs.haloagents.ai/getting-started/introduction.md): Halo is an AI-native customer support platform that knows your product, your customers, and what's happening for them right now.
- [Quickstart](https://docs.haloagents.ai/getting-started/quickstart.md): Install the Halo widget, identify your first user, and have a real AI conversation in under 5 minutes.
- [Setup Checklist](https://docs.haloagents.ai/getting-started/setup-checklist.md): The end-to-end setup journey: knowledge, agents, channels, integrations, team, and going live.
- [Contact Us](https://docs.haloagents.ai/help-and-support/contact-us.md): How to reach the HaloAgents team for support, sales, and security disclosures.
- [Frequently Asked Questions](https://docs.haloagents.ai/help-and-support/faq.md): Answers to the questions we hear most often about HaloAgents.
- [Feature Request](https://docs.haloagents.ai/help-and-support/feature-request.md): Suggest new features, integrations, and improvements for HaloAgents.
- [Help Center](https://docs.haloagents.ai/help-and-support/help-center.md): Get support and find resources to help you get the most out of HaloAgents.
- [Report a Bug](https://docs.haloagents.ai/help-and-support/report-bug.md): How to report a bug in HaloAgents and what to include so we can fix it fast.
- [Help Center Analytics](https://docs.haloagents.ai/help-center/analytics.md): Track pageviews, top searches, zero-result queries, and per-article performance.
- [Articles](https://docs.haloagents.ai/help-center/articles.md): The block-style editor, AI-assisted writing, SEO, versioning, scheduling, and translations.
- [Collections](https://docs.haloagents.ai/help-center/collections.md): Group articles into navigable categories with icons, descriptions, and SEO fields.
- [Design](https://docs.haloagents.ai/help-center/design.md): Theme your help center: colors, fonts, hero, layout, footer, embedded chat, and custom CSS.
- [Domains & Publishing](https://docs.haloagents.ai/help-center/domains.md): Set up a custom domain like help.yourcompany.com, configure indexing, and go live.
- [Migrating from Another Help Center](https://docs.haloagents.ai/help-center/migrating.md): Import articles via URL crawl or Intercom API, including structure detection and per-article extraction.
- [Help Center Overview](https://docs.haloagents.ai/help-center/overview.md): A hosted, themeable help center site that serves your customers and trains your AI.
- [Live Conversations](https://docs.haloagents.ai/inbox/live-conversations.md): Watch your AI agent in real time, coach mid-conversation, and take over when needed.
- [Inbox Overview](https://docs.haloagents.ai/inbox/overview.md): Halo's unified inbox for tickets and conversations. Where your team works alongside the AI.
- [Tickets vs Conversations](https://docs.haloagents.ai/inbox/tickets-vs-conversations.md): Two related-but-distinct concepts in the Halo inbox. What they are, when each is created, and how they connect.
- [Views, Segments & Custom Inboxes](https://docs.haloagents.ai/inbox/views-and-segments.md): Slice the inbox by status, search, segment, or saved custom inbox.
- [Working Tickets](https://docs.haloagents.ai/inbox/working-tickets.md): Replies, internal notes, AI-drafted responses, and how to move tickets through their statuses.
- [Fathom](https://docs.haloagents.ai/integrations/fathom.md): Sync Fathom meeting transcripts and attendee insights as searchable knowledge.
- [HubSpot](https://docs.haloagents.ai/integrations/hubspot.md): Bidirectional CRM sync. Halo ingests contacts, companies, deals, and engagements; agents can create deals, log activities, update contacts, and attach notes.
- [Intercom](https://docs.haloagents.ai/integrations/intercom.md): Import contacts, companies, conversations, and tickets from Intercom into Halo. Best for migrating from Intercom or running both in parallel.
- [Linear](https://docs.haloagents.ai/integrations/linear.md): AI files bug tickets and feature requests in Linear. The Linear Agent replies to dev comments on tracked issues with original conversation context.
- [Integration Modes](https://docs.haloagents.ai/integrations/modes.md): Ingest, Actions, and Notifications: the three things an integration can do for you.
- [Integrations](https://docs.haloagents.ai/integrations/overview.md): Connect HaloAgents with your favorite tools so the AI sees real customer context, takes action in your stack, and routes alerts to the right place.
- [PandaDoc](https://docs.haloagents.ai/integrations/pandadoc.md): Sync contracts and signer activity. Auto-link contracts to companies by signer email and surface contract events in Slack.
- [Slack](https://docs.haloagents.ai/integrations/slack.md): Run an AI agent in mapped Slack channels, post messages from agents, and route notifications from across Halo into Slack.
- [Stripe](https://docs.haloagents.ai/integrations/stripe.md): Sync customers, subscriptions, and payments. Power renewal data and let agents request refunds, cancellations, and credits through a human approval queue.
- [Zoom](https://docs.haloagents.ai/integrations/zoom.md): Sync Zoom meeting transcripts and recordings as searchable knowledge for your AI agent.
- [AI Learning Priority](https://docs.haloagents.ai/knowledge/ai-learning-priority.md): How Halo decides what your AI learns from, and what wins when sources disagree.
- [Web Crawler](https://docs.haloagents.ai/knowledge/crawler.md): Technical reference for the Halo web crawler. User-Agent, sitemap-driven sync, and how to allowlist it.
- [Files & Internal Docs](https://docs.haloagents.ai/knowledge/files-and-docs.md): Upload files directly or write knowledge articles in the dashboard. For content that doesn't live on a public URL.
- [Learning Rules](https://docs.haloagents.ai/knowledge/learning-rules.md): Tell Halo what to learn from synced integration data — and what to ignore.
- [Knowledge](https://docs.haloagents.ai/knowledge/overview.md): Everything your AI knows, in one place. The eight sections of the Knowledge dashboard, what each one does, and how they fit together.
- [URL Sources](https://docs.haloagents.ai/knowledge/url-sources.md): Crawl your help center or docs site so every page becomes searchable knowledge for your AI.
- [Connecting Clients](https://docs.haloagents.ai/mcp/connecting-clients.md): Install Halo as an MCP server in Claude Desktop, Cursor, VS Code, or any MCP-aware client. OAuth setup is fully automatic on first connect.
- [External MCP Servers](https://docs.haloagents.ai/mcp/external-servers.md): Connect a third-party MCP server to your org and its tools become available as agent actions, alongside Halo's built-in integrations.
- [MCP Overview](https://docs.haloagents.ai/mcp/overview.md): Connect your AI tools to HaloAgents via the Model Context Protocol, and bring your own MCP servers in as agent actions.
- [Protocol Reference](https://docs.haloagents.ai/mcp/protocol.md): JSON-RPC methods, OAuth endpoints, discovery URLs, and rate limits. For developers building custom MCP clients against Halo.
- [Scopes & Permissions](https://docs.haloagents.ai/mcp/scopes-and-permissions.md): The MCP scope grammar, the three-layer gating model, and how Halo binds tokens to customers.
- [AI Agent Settings](https://docs.haloagents.ai/settings/ai-agents-settings.md): Org-level settings that apply across all your AI agents.
- [Data Settings](https://docs.haloagents.ai/settings/data.md): Discovered attributes, field descriptions, and custom fields for lead capture and profiles.
- [Inbound Log](https://docs.haloagents.ai/settings/inbound-log.md): Every inbound email Mailgun delivers to Halo, with outcome status and decision trace.
- [Inbox Views & Custom Inboxes](https://docs.haloagents.ai/settings/inbox-views.md): Auto-assign on reply, offline emails, spam rules, and saved custom inbox views.
- [Roles & Permissions](https://docs.haloagents.ai/settings/roles-and-permissions.md): Control what each teammate can see and do with roles, presets, and granular module-level permissions.
- [Routing Rules](https://docs.haloagents.ai/settings/routing.md): First-match-wins rules that send a fresh ticket to the right inbox, priority, category, and assignee. With a live dry-run preview before you save.
- [Security](https://docs.haloagents.ai/settings/security.md): Two-factor authentication, session timeout, and identity verification.
- [System Prompts (Admins)](https://docs.haloagents.ai/settings/system-prompts.md): Global instructions appended to every AI response across all agents. Admin-only.
- [Team](https://docs.haloagents.ai/settings/team.md): Invite teammates, manage their access, and set up alias users for outbound emails.
- [Changelog](https://docs.haloagents.ai/web-widget/changelog.md): Every released version of the Halo web widget SDK, with what changed and how to upgrade.
- [Customize the Widget](https://docs.haloagents.ai/web-widget/customization.md): Control the trigger, open programmatically, theme, position, and use UI highlighting to guide users through your product.
- [Identify Users & Companies](https://docs.haloagents.ai/web-widget/identify-users.md): Tell the AI who the current user is and what company they belong to.
- [Installation](https://docs.haloagents.ai/web-widget/installation.md): Add the Halo widget to your site with a single script tag.
- [Methods Reference](https://docs.haloagents.ai/web-widget/methods.md): Every method available on the HaloAgents instance, plus static methods on the global.
- [Send Context](https://docs.haloagents.ai/web-widget/send-context.md): Push structured, real-time data about the user's current state to the AI via setContext().
- [Troubleshooting](https://docs.haloagents.ai/web-widget/troubleshooting.md): Debug installation issues, identity problems, missing chrome, and silent failures with HaloAgents.debug().

## OpenAPI Specs

- [openapi](https://docs.haloagents.ai/api-reference/openapi.json)