> ## Documentation Index
> Fetch the complete documentation index at: https://docs.haloagents.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Halo in ChatGPT

> Install the Halo plugin in ChatGPT or Codex to answer customers, research accounts, review support quality, build outreach and run onboarding from a conversation.

Halo works as a plugin for ChatGPT and Codex: connect it in Developer mode today, or install it from the directory once Halo is published there. Once installed, ChatGPT can read and answer your support conversations, look up any contact or company and replay their history, review negative feedback and unresolved questions, draft and launch outreach, and work your customer-success pipelines. The plugin bundles six skills (triage the inbox, research a customer, support insights, build outreach, customer onboarding, install the widget) that teach ChatGPT the order of operations for each job.

## Before you connect

* A Halo workspace. [Start one](https://app.haloagents.ai/signup) if you do not have one.
* To grant write access (replying to customers, changing records, launching outreach), you need the matching permissions in Halo yourself. The consent screen only offers what you hold, and every write re-checks it.

## Install from the directory

Once Halo is published in the directory:

1. In ChatGPT, open **Settings > Apps & Connectors** and search for **Halo**.
2. Choose **Connect**. ChatGPT opens the Halo consent screen.
3. Sign in to Halo if asked, choose the **permissions** ChatGPT should have (read permissions are pre-selected; write permissions start unchecked), and choose **Authorize**.
4. Mention Halo in a conversation, or pick one of the starter prompts.

Tokens refresh automatically and expire after an hour. To revoke access, remove the plugin in ChatGPT; the refresh token is discarded with it. A Halo admin can also remove the operator who connected it from the workspace, which invalidates every token they granted.

## Connect in Developer mode

If the plugin is not available to your ChatGPT workspace yet, connect the MCP server directly. In ChatGPT open **Settings > Apps & Connectors**, enable **Developer mode**, create a connector and use:

```
https://app.haloagents.ai/api/mcp/chatgpt
```

ChatGPT discovers Halo's OAuth metadata, identifies itself with its client metadata document, and sends you to the same consent screen. This URL is the ChatGPT surface of the Halo MCP server: the same tools and permissions as `/api/mcp`, with tool discovery open before sign-in because ChatGPT lists tools before an account is linked. Use `/api/mcp` for every other client.

## What you can ask

> "Show me the open tickets about invoices and draft a reply to each."

> "Who at Acme has written in this quarter, and what did we tell them?"

> "What went badly in support this week, and what should we fix first?"

> "Create a broadcast about the new reporting dashboard, send me a test and tell me how many people would get it."

> "Which onboardings are stuck? Log a note on each and create a follow-up task."

## What the plugin can do

| Area | Tools |
| - | - |
| Inbox | Search and read tickets and transcripts; reply over chat or email; add internal notes; set status, assign, snooze, move; create tickets; message a customer |
| Contacts and companies | Find and search contacts, leads and companies; replay a contact's journey; create and update records |
| Workspace data | Semantic search across your knowledge base, help center, synced CRM data and past conversations; KPIs and time series; HubSpot and Stripe lookups; negative feedback, unresolved questions, low-sentiment conversations; web search and fetch |
| Outreach | Create broadcasts, series, in-app messages and banners; senders and merge fields; steps in markdown; audiences from saved segments; readiness check, test send, audience preview, activation and pause |
| Customer success | Onboarding pipelines and deals, stage moves, notes; issues and comments; tasks |
| Workflows | List, read, create, activate, pause and resume workflows; enroll and cancel records |
| Setup and docs | Widget install snippet, identity JWT sample, Halo documentation search |
| Connected integrations | Actions your workspace has enabled in HubSpot, Slack, Stripe and OrbitForms |

Every tool declares whether it only reads, whether it changes or sends something, and whether it reaches outside Halo, so ChatGPT confirms before any write. Outreach activation additionally requires the recipient count from the audience preview.

## Permissions

The consent screen lists every permission ChatGPT asks for, grouped into **Read** and **Write**. Write permissions are never implied by read ones, and the plugin can never do more than the person who connected it. Integration secrets never leave Halo. See [Scopes & Permissions](https://docs.haloagents.ai/mcp/scopes-and-permissions.md) for the scope list and token lifetimes.

## Troubleshooting

* **A write tool says a permission is missing**: disconnect and reconnect the plugin, then tick the write permission on the consent screen.
* **ChatGPT cannot connect to a custom URL**: make sure you used `https://app.haloagents.ai/api/mcp/chatgpt`; the canonical `/api/mcp` URL requires sign-in before listing tools, which ChatGPT's connector flow does not expect.
* **No tools appear**: your workspace's plan does not include that feature, or the MCP server was disabled for your workspace. Ask your Halo admin.
* Still stuck? Email [support@haloagents.ai](mailto:support@haloagents.ai).


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