> ## 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 Zoho Desk email to a Voiceflow agent

> Forward support email into a Zoho Desk department, poll automation-assigned tickets and send reviewed Voiceflow replies with Zoho Desk's email reply API.

## Overview

Forward support email into a Zoho Desk department, poll automation-assigned tickets and send reviewed Voiceflow replies with Zoho Desk's email reply API.

**Note:** 

Use [Zoho Mail](/docs/guides/channels/email/zoho-mail) when the mailbox itself is the destination. This guide installs an agent on Zoho Desk tickets; its Desk scopes, organization and department are independent of a Zoho Mail account.

<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. |
| Zoho Desk | Help desk organization with API access and a Support Administrator for email setup. |
| Email | Verified support alias/forwarding route and configured outgoing From address in one department. |
| OAuth | Regional client with `Desk.tickets.READ` and `Desk.tickets.UPDATE`, organization ID and an authorized automation agent. |

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. Route email into the pilot department

Under **Setup → Channels → Email**, add/select the support alias and map it to the pilot department. Forward the custom support address to its equivalent Desk address and complete the verification ticket. Configure the displayed SPF/DKIM or your permitted outgoing server, then confirm a manual ticket reply reaches an external inbox. See [Zoho Desk's email setup](https://help.zoho.com/portal/en/kb/desk/support-channels/email/articles/setting-up-your-email-channel).

Assign only pilot email tickets to the automation agent. Keep department and address routing narrow; Zoho Mail and Zoho Desk are separate services and credentials.

### 2. Create and store the regional OAuth grant

Register a Self Client in the Zoho API Console for the same data center as Desk. Generate an offline grant code for `Desk.tickets.READ,Desk.tickets.UPDATE`, authorized as the agent with access to the pilot department. Set `PROVIDER=zoho-desk`, `HD_CLIENT_ID`, `HD_CLIENT_SECRET`, `HD_AUTH_CODE` and `ZOHO_ACCOUNTS` to that data center's Accounts origin. Set `HD_ORIGIN` to its Desk origin, such as `https://desk.zoho.com`; do not mix regions.

Set `ZOHO_ORG_ID` to your Desk organization ID, `HD_OWNER_ID` from a pilot ticket's `assigneeId` and `HD_SCOPE_ID` from `departmentId`. Set the mailbox/sender fields to the configured support address. Leave `HD_TOKEN` empty. Exchange the short-lived grant promptly:

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

The helper stores access/refresh tokens in SQLite; remove `HD_AUTH_CODE` from `.env` after success. `HD_REFRESH_TOKEN` may remain a nonempty marker such as `stored-in-database` because the stored grant owns refresh. Preserve this database when hosting. The relay renews access tokens, retaining any rotated refresh token.

### 3. Send an email reply to the original thread

The relay paginates department/assignee tickets, loads their thread histories and requests `include=plainText` for each thread. It requires an open ticket and a public incoming email. Forwarded, truncated and attachment-bearing input is excluded or held.

The [Desk API](https://desk.zoho.com/DeskAPIDocument) email reply operation uses `POST https://desk.zoho.com/api/v1/tickets/{id}/sendReply?sendImmediately=true`, with `channel=EMAIL`, configured `fromEmailAddress`, customer `to`, reviewed plain text and `inReplyToThreadId`. The OAuth Authorization header and `orgId` header are both required. A private or draft thread does not send the customer an answer.

To inspect the native IDs, first fill this provider's credentials (and exchange the Zoho Desk grant if applicable), then run the supplied read-only helper in a private terminal:

```sh
node --env-file=.env helpdesk-discover.mjs '/api/v1/tickets/PILOT_TICKET_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
{"channel":"EMAIL","contentType":"plainText","content":"Reviewed answer","fromEmailAddress":"support@example.com","to":"customer@example.net","inReplyToThreadId":"INCOMING_THREAD_ID","isForward":false,"isPrivate":false,"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.

Zoho Desk's ticket ID plus actual customer address scopes the session. Native thread IDs select the reply target; the service handles email headers. A changed Reply-To address is held for review rather than silently changing the customer recipient.

| 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.

Check the outgoing email thread's status and actual recipient delivery. A `PENDING` response is queued work, not inbox acceptance; inspect failed threads and sender-domain verification before another attempt.

### 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.

Check Accounts/Desk region, `orgId`, token scopes and department permissions. Truncated content remains held; inspect full original content in Desk. If refresh is revoked, stop the worker, repeat the grant exchange and restart using the same database after reconciling pending work.

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.
