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

# Help Scout plugin

> Manage mailboxes, conversations, customer profiles, threads, tags, saved replies, and reports with Help Scout Mailbox API 2.0.

Use **Help Scout** through Corsair: one client, typed API calls.

**Authentication.** Help Scout has no API keys: every token comes from a Help Scout app (Your Profile > My Apps) and lasts 2 days. Two ways to connect. `oauth_2` (default): each Help Scout account authorizes through an OAuth app, Corsair's or your own; Corsair renews the token with the stored refresh token. `api_key`: connect one Help Scout account with its own app by storing the app's App ID as `client_id` and App Secret as `client_secret` (no redirect URL needed): `pnpm corsair setup --plugin=helpscout client_id=<app-id> client_secret=<app-secret>`, or the Client ID and Client secret fields of Hub's connect page, with the API key field left empty. The plugin mints a token with Help Scout's client-credentials grant, keeps it in `api_key` and mints a new one before it expires. Either way, a read that gets a 401 renews the token once and retries; a write that gets a 401 fails and is not retried. Passing `key` in plugin options sends that token as is, with no renewal.

**Rate Limiting.** The Mailbox API enforces rate limits per tenant. Corsair's HTTP transport retries a 429 up to three times, honoring `Retry-After`.

**Resource Identification.** Help Scout numeric IDs are integers or digit strings. Path parameters accept both numbers and numeric strings.

**What you get:**

* 55 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/helpscout better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/helpscout better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/helpscout better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/helpscout better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { helpscout } from '@corsair-dev/helpscout';

export const corsair = createCorsair({
	plugins: [
		helpscout(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] OAuth 2.0 (Recommended)
>
> Open [hub.corsair.dev](https://hub.corsair.dev/dashboard), navigate to your project, and enter the **client ID** and **client secret** from your Help Scout OAuth app.
>
> ```ts theme={null}
> helpscout()
> ```
>
> More: [OAuth 2.0](https://docs.corsair.dev/concepts/oauth)

> [tab] API Key
>
> Store the Help Scout API key before the first call: `pnpm corsair setup --plugin=helpscout --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> helpscout({
> 	authType: 'api_key',
> })
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'helpscout',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List mailboxes**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.helpscout.api.mailboxes.list({});
```

**Delete a conversation**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.helpscout.api.conversations.delete({ conversationId: 1000 });
```

See the full list on the [API](https://docs.corsair.dev/plugins/helpscout/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/helpscout/api.md)
>
> Every `helpscout.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


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