Zoho Desk Self Clients

This guide covers Sim's Zoho Desk Self Client connection. It collects a Client ID, client secret, organization ID, and data center, then requests access tokens for the configured Desk organization.

Prerequisites

In Sim, you need workspace write access and permission to manage integrations.

You need a Zoho account with access to the Zoho API Console for your data center, for the same organization your Zoho Desk portal belongs to, and the Zoho Desk organization ID for that portal. See Know Your Data Center for the console that matches your region.

A Self Client can authenticate against the US, EU, IN, or AU accounts server — pick your region from the Data center dropdown when you add the credential, or leave it unset for US. Organizations in the JP, CA, SA, CN, or UK data centers are not supported yet. API calls are then routed to the Desk host for that same region, and Sim uses that region’s Desk host unless Zoho returns another allowed API domain.

The interactive OAuth connection is a separate path and remains US-only (accounts.zoho.com), so a non-US organization can connect only through a Self Client.

Setting up the Self Client

1. Create the Self Client

1. 1

   Sign in to the Zoho API Console for your data center with the Zoho account that owns the Desk portal — see Know Your Data Center for the right one. A Self Client is registered in one data center and cannot authenticate against another region's accounts server

2. 2

   Click Add Client, choose Self Client, and click Create — then OK on the confirmation

3. 3

   Open the new client and switch to the Client Secret tab. Copy the Client ID and Client Secret — these are two of the three values you'll paste into Sim

You do not need the Generate Code tab. That tab produces a one-time authorization code for the code-exchange flow; the client-credentials flow Sim uses needs only the client ID, the client secret, and your organization ID.

2. Find your organization ID

1. 1

   Open Zoho Desk and go to Setup (the gear icon) → Developer Space → API

2. 2

   Copy the numeric Organization ID (also called the Org ID or portal ID) shown there — for example 600123456

3. Know your data center

Zoho hosts each organization in one data center, and the accounts server that issues tokens is per region. Look at the URL you use to sign in to Zoho Desk and pick the matching region in the Data center dropdown:

Organizations in the JP, CA, SA, CN, and UK data centers cannot be connected yet.

4. Scopes

Sim requests the Zoho Desk scopes used by its tools, knowledge connector, organization picker, and webhook trigger — the same Desk scope list on both connection types:

Desk.tickets.READ
Desk.tickets.CREATE
Desk.tickets.UPDATE
Desk.contacts.READ
Desk.contacts.CREATE
Desk.contacts.UPDATE
Desk.accounts.READ
Desk.accounts.CREATE
Desk.accounts.UPDATE
Desk.search.READ
Desk.departments.READ
Desk.agents.READ
Desk.basic.READ
Desk.articles.READ
Desk.organization.READ
Desk.webhooks.CREATE
Desk.webhooks.DELETE

Sim sends this list on every token request, so there is nothing to pre-configure on the Self Client itself. The aaaserver.profile.READ scope Sim requests on the interactive OAuth flow is deliberately left off this grant — it is an Accounts profile scope, and this grant never calls the Accounts profile endpoint; identity is synthesized from the organization ID. If Zoho rejects the request with an invalid-scope error, the Self Client's owner does not have access to one of the Desk modules above in that organization.

Desk.articles.READ supports the knowledge connector, and Desk.organization.READ supports the organization picker. Desk.webhooks.CREATE and Desk.webhooks.DELETE belong to the trigger, which runs on an OAuth connection only (see Triggers below). A Free or Standard Desk plan may reject those scopes because webhooks require Professional or higher.

A scope that is granted but insufficient surfaces at run time as a 4xx from the Zoho Desk API naming the scope problem.

5. Protect the client secret

The client secret can mint access tokens for the configured Zoho Desk organization and requested scopes. Treat it like a password — do not commit it to source control or share it publicly. Sim encrypts it at rest.

Regenerating or revoking the Self Client in the Zoho API Console invalidates the stored pair immediately. If you rotate it, update the credential in Sim right away.

Adding the Self Client to Sim

1. 1

   Open Integrations from your workspace sidebar

2. 2

   Search for "Zoho Desk" and open it, then click Add to Sim and choose Add Self Client

3. 3

   In the Add Zoho Desk Self Client dialog, paste the Client ID, the Client secret, and the numeric Organization ID. Pick your region from the Data center dropdown — leaving it unset uses the United States. Optionally set a display name and description

4. 4

   Click Add Self Client. Sim verifies the credentials by minting a real access token from Zoho — if it fails, the error tells you whether Zoho rejected the credentials or couldn't be reached.

Using the Self Client in workflows

Add a Zoho Desk block to your workflow. In the credential dropdown, your Self Client appears alongside any OAuth credentials. Choose the operation and configure its inputs. The block calls the Zoho Desk REST API with a freshly minted access token — the same requests as the OAuth flow, so the Zoho Desk tools work the same way, subject to the scopes above.

Get Attachment has not been verified with this Self Client flow. If it returns a scope error, contact support with the operation and error details; the requested scope list is managed by Sim.

Triggers still need OAuth

The Zoho Desk trigger provisions and tears down its own webhook subscription against your Desk organization, and that provisioning path currently runs only against a personal OAuth connection. Connect a Zoho Desk account through OAuth for triggers, and use the Self Client for the blocks that read and update tickets.

Because the OAuth flow is US-only, an organization outside the US data center can use Zoho Desk blocks through a Self Client but cannot use the Zoho Desk trigger.

Token behavior

Access tokens minted from a Self Client live for one hour and there is no refresh token — Sim mints a new token whenever one is needed, and caches the current one until it is close to expiry. Two events invalidate the stored credential:

• Revoking or deleting the Self Client in the Zoho API Console — no new tokens can be minted
• Regenerating the client secret — the stored pair stops working; paste the new secret into the credential in Sim

Troubleshoot connection errors

For this connection, Sim uses Zoho's Self Client client-credentials flow, which returns no refresh token. External setup is documented by Zoho; a successful connection and representative workflow calls are still needed to verify access for your portal.