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

# Connect Help Scout email to a Voiceflow agent

> Forward support email into a Help Scout Inbox, poll conversations assigned to your automation user and publish reviewed Voiceflow replies through the Inbox API.

## Overview

Forward support email into a Help Scout Inbox, poll conversations assigned to your automation user and publish reviewed Voiceflow replies through the Inbox API.

**Note:** 

Help Scout recommends its newer v3 list API for larger accounts. This supplied implementation consistently uses supported v2 list/read/reply schemas; do not mix v3's renamed filters into v2 requests. Webhooks are another receiver, not part of this polling walkthrough.

<a id="before-you-begin"></a>

## Before you begin

Prepare the agent, platform administrator and relay operator.

Use an existing [support agent](/docs/guides/usecases/customer-service/build-faq-agent) with approved public [Knowledge](/docs/documentation/build/importing-data-sources). The agent owner publishes the intended Environment; the help desk administrator owns email routing and assignment; a backend developer operates the relay.

| Requirement | What to prepare |
| --- | --- |
| Voiceflow | Project ID, server-side project API key and released Environment alias. |
| Host | Node 24.14.1 and one persistent worker with encrypted SQLite storage; the bundle supplies Docker/Compose. |
| Test | A customer inbox you control, an expected policy answer and a human support owner. |
| Help Scout | Paid account with Inbox API access, an active invited user and administration access to the pilot Inbox. |
| Receiving | A working custom-address forwarding route into one Help Scout Inbox. |
| API | An OAuth application owned by the automation user; client ID and client secret for the internal client-credentials flow. |

This supervised example answers public support questions. Email addresses and help desk records do not authorize access to private customer data. Keep `AUTO_SEND=false`: APIs do not consistently expose raw automatic-response headers, so a person reviews every outbound message and its recipients.

<a id="prepare-relay"></a>

## Prepare the relay

Install the supplied implementation and durable review queue.

### 1. Configure the executable service

Extract the [relay bundle](/docs/examples/email-relay/email-relay.zip), enter `email-relay` and run with Node 24.14.1:

```sh
npm ci
cp .env.example .env
chmod 600 .env
openssl rand -hex 32
```

Use the generated value for `IDENTITY_SECRET`. Set `VF_PROJECT_ID`, `VF_API_KEY`, `VF_ENVIRONMENT`, a fixed UTC `ACCEPT_AFTER` just before the pilot and `ALLOW_SENDERS` to your test inbox. Keep `AUTO_SEND=false` and `POLL_SECONDS=60`. The provider steps below supply the remaining fields.

The bundle's `helpdesk-adapters.mjs` implements the exact provider calls; `helpdesk.mjs` checks ownership and input, and the shared worker stores message identities, sessions and cached replies. Read its `HELPDESKS.md` for file/operation mapping.

### 2. Keep one worker and a narrow pilot

Use one process/database for this provider, address, automation owner and scope. The relay scans the selected pilot work and paginates histories; it does not use a webhook or expiring event subscription. API/OAuth credentials still require renewal or rotation. Its 300-page cap fails visibly rather than silently truncating a large scan.

This is a small supervised deployment with no distributed lease or bounded work queue. Monitor quota, disk and oldest pending work; add incremental ingestion and capacity controls before a high-volume rollout.

<a id="connect-email"></a>

## Connect receiving and replies

Configure the native email channel and its API permissions.

### 1. Forward mail into one Inbox

Open **Settings → Inboxes → your Inbox → Connect Email & Social**, set the domain address and copy the Help Scout receiving address. Configure forwarding/redirection with your mailbox provider, complete verification and send a test from an external inbox. Configure the Inbox's outgoing identity and domain authentication, then send a manual reply. [Help Scout's forwarding instructions](https://docs.helpscout.com/article/1752-forward-your-shared-email-in-to-help-scout) cover the provider handoff.

Use one pilot Inbox and a dedicated automation user. A workflow may assign permitted test senders to that user; human work stays assigned elsewhere. Disable competing automatic answers for the pilot.

### 2. Create the internal OAuth application

As the active automation user, open **Your Profile → My apps → Create My App** and obtain its client ID/secret. Set `PROVIDER=help-scout`, `HD_CLIENT_ID` and `HD_CLIENT_SECRET`; leave `HD_TOKEN` empty. The relay uses `POST https://api.helpscout.net/v2/oauth2/token` with `grant_type=client_credentials` and renews expiring access tokens automatically.

Set `HD_SCOPE_ID` from the pilot conversation's `mailboxId`, and `HD_OWNER_ID` from `assignee.id` in `GET https://api.helpscout.net/v2/conversations/{id}`. Set the mailbox/sender fields to the Inbox's custom support address. The OAuth application acts with its resource owner's access; keep that user active and authorized for the Inbox.

### 3. Publish a reply thread that sends email

The relay uses supported v2 conversation/thread endpoints, paginates their HAL links and filters the configured Inbox/assignee. Only published customer email threads reach the agent. It converts HTML to text without fetching remote content; notes, replies and hidden/draft threads cannot start a customer turn.

`POST https://api.helpscout.net/v2/conversations/{id}/reply` supplies the native customer ID, reviewed text, `draft=false`, `imported=false`, the automation user and `status=active`. [Imported threads](https://developer.helpscout.com/mailbox-api/endpoints/conversations/threads/reply/) do not send notifications. The example preserves the automation assignee rather than relying on Inbox reply-assignment defaults.

To inspect the native IDs, first fill this provider's credentials, then run the supplied read-only helper in a private terminal:

```sh
node --env-file=.env helpdesk-discover.mjs '/v2/conversations/PILOT_CONVERSATION_ID'
```

Replace any `PILOT_…_ID` with the native ID from a ticket/conversation you can open. The helper permits ID discovery before owner/scope fields are filled; it only performs GET requests plus any required OAuth token exchange. Its output can contain customer data. Copy the fields identified above, then run the scoped check below.

The supplied adapter builds this reply payload after approval; replaceable IDs come from the native incoming record, not from the language model:

```json
{"customer":{"id":123},"text":"Reviewed answer","draft":false,"imported":false,"user":456,"assignTo":456,"status":"active","cc":[],"bcc":[]}
```

<a id="host-relay"></a>

## Run the persistent worker

Verify read access, then start processing without a public webhook.

### 1. Check the native route without sending

After filling `.env`, run:

```sh
node --env-file=.env helpdesk-check.mjs
```

Expect your test ticket/conversation with the correct owner, `open=true`, `scoped=true` and `eligible=true`. This command may obtain/cache an OAuth token but sends no Voiceflow turns or customer replies. Resolve access/routing problems before starting the worker.

### 2. Start locally, then host the same state

```sh
npm start
```

In another terminal, `curl -f http://127.0.0.1:8080/health` should report running. No public `/inbound` endpoint is enabled for help desks. Polling uses outbound HTTPS and stored server credentials; there is no incoming webhook secret or subscription to configure.

For a persistent Linux host, install Docker/Compose, copy the bundle and protected `.env`, set `DB_PATH=/app/data/relay.sqlite`, and run `docker compose up -d --build`. The supplied service has a persistent volume and restart policy; port 8080 is bound to host loopback. Keep it private. If you obtained a local OAuth grant, stop the local worker and copy its complete stopped database into the host volume before starting; never run both copies. The bundle README gives the exact database copy commands.

<a id="conversation-mapping"></a>

## Keep tickets and sessions aligned

Use native ownership, message identity and the actual customer sender.

The native conversation ID plus customer address keeps the session separate from other Inbox conversations. Help Scout handles outbound email headers and reply threading. Only the primary customer's published email threads qualify; handle participant changes in Help Scout.

| Control | What the supplied relay does |
| --- | --- |
| Deduplication | Persists native message IDs; repeat scans cannot resend the same job. |
| Customer burst | Combines messages received before the first turn. New input overlapping an already generated/uncertain answer is held for human reconciliation. |
| Takeover | Re-reads ownership, scope and latest content before the turn and before sending; stale jobs become `ignored`. |
| Content | Holds files, truncated/missing text, changed Reply-To, forwards and input over 12,000 characters. |
| Output | Caches text traces; holds interactive/handoff output for a written reply. |

Reassign to a person **before** replying manually. The recheck is not a universal lock: keep competing humans/automations outside this assignment. Resolve old held jobs before returning work to automation.

For additions during review, `show` identifies `helpdesk.priorJobs` and the hold reason. Inspect those cached answers and all new questions, discard stale work, then write one reconciled reply for the newest held job; the agent does not replay earlier messages.

Files stay in the help desk and are never fetched or forwarded. Check original quoted/inline content; the quote heuristic is limited. Outgoing/agent messages cannot start self-reply loops. Manual review also screens external auto-responses whose raw headers the API omits.

<a id="test-conversation"></a>

## Test the complete conversation

Prove receiving, agent execution and actual email delivery separately.

### 1. Receive, review and deliver the first answer

From the permitted external inbox, email the support address. Confirm the native ticket/conversation and its automation assignment, then inspect the queue and Voiceflow transcript:

```sh
node --env-file=.env cli.mjs list
node --env-file=.env cli.mjs show JOB_ID
node --env-file=.env cli.mjs approve JOB_ID
```

Replace `JOB_ID` with the actual ID from `list`. Approve only after checking the question, cached answer, original sender/recipients and support identity; the next worker pass sends it. For `review-input`, have a person inspect the original and write a reply with the shared [review workflow](/docs/guides/channels/email/review-replies-before-sending). Expected result: one runtime answer, one reviewed native reply and an email in the test customer's inbox.

Confirm a published reply, successful delivery and the actual customer inbox. A draft, imported thread, bounced thread or Collision Detection hold is not a delivered answer.

### 2. Test continuation, takeover and recovery

Reply in-thread with a follow-up requiring earlier context. Expect the same native conversation and sender-scoped runtime session. Send a separate new support request and expect a new session. Repeat polling and restart the worker; expect no duplicate answer for an already processed native message.

While a reply awaits approval, reassign the ticket to a person, then approve the cached job in this controlled test. Expect `ignored` and no email. Also test a human reply, two consecutive customer messages, an attachment, an auto-response and a changed Reply-To where supported. Reconcile/discard held work before assigning the conversation back. Finally exercise a controlled API rejection and interrupted send, then use recovery below.

<a id="troubleshooting" />

### The email never becomes eligible work

Check the native email channel before the agent.

Confirm a real incoming email record, open status, exact automation owner, scope/address and pilot cutoff. The read-only check reports these separately. Check sender allowlisting and provider API permissions; a healthy process cannot prove the support mailbox is receiving. A private note, outgoing email, archived ticket or unrelated channel should not run the agent.

### The answer is held or becomes stale

Inspect the durable state and original conversation.

`review-input` needs an operator-written answer after inspecting the original; `review` has a cached candidate. `ignored` with a ticket-change explanation means the ownership/content guard prevented a stale reply. Do not force it through by resetting the database. Discard old held work after the human takes responsibility. Check the released Environment and runtime transcript for `uncertain-turn`.

### The reply was accepted but no email arrived

Reconcile provider delivery before any retry.

A merged conversation can return 301 or 404; the relay stops instead of silently moving credentials or sessions. Resolve the merge in Help Scout. A 412 can indicate an old/locked conversation or thread-count limit; have a person continue through a valid conversation.

Keep a timed-out write in `uncertain-send` until native history proves whether it was accepted. Never rerun the agent to recreate a cached answer. A 429 backs off using Retry-After; the sample never retries a write automatically.

<a id="go-live"></a>

## Release and maintain the connection

Keep review, assignment and durable recovery in place.

### 1. Release the reviewed support route

Publish the reviewed Voiceflow Environment, deploy one worker and repeat the entire customer test through the production support address. Keep `AUTO_SEND=false`; the example enforces it for help desks. Widen `ALLOW_SENDERS` only with approved public-support scope, abuse controls and staffed review. Record API/seat access, email delivery and takeover acceptance in your deployment record.

Changing provider, address, owner/scope, project, Environment, cutoff or identity secret requires draining/resolving old work and a new database. Credential rotation alone does not. Stop the worker before copying/backing up SQLite, preserve its WAL if present, encrypt backups and set retention for help desk content, transcripts and local records.

### 2. Recover without replaying unknown writes

`uncertain-turn` may include completed tool side effects: inspect the transcript before using `restart JOB_ID --reviewed-side-effects`. For `uncertain-send`, inspect native history and delivery. If already sent, use `mark-sent JOB_ID`; if confirmed never accepted, use `retry-send JOB_ID --confirmed-not-sent` to retry the cached answer. Run these through `node --env-file=.env cli.mjs …`; ownership is checked again before any send.

Monitor poll errors, API quota, failed delivery, disk and held-job age. Rotate/revoke credentials with the provider administrator and retest. For rollback, route/assign work to human support, resolve queued jobs, stop the relay and then revoke its credentials. Receiving remains in the help desk during relay outages; reconcile the native backlog against durable jobs before resuming.
