Zoho Desk

📘
Check out the Zoho Desk API docs for more information.

Set up

The connector authenticates with a Zoho Self Client using the Client Credentials flow, so no user sign-in is needed. Before you begin, make sure you have the following information available:

Data Center: The region your Zoho Desk account is hosted in. This matches the domain you use to log in, e.g. desk.zoho.eu is European Union and desk.zoho.com is United States.
Organization ID: Your Zoho Desk organisation's numeric ID (e.g. 20082414277).
Client ID & Client Secret: From a Self Client created in the Zoho API Console.

Create a Self Client

Go to the Zoho API Console for your data center, e.g. api-console.zoho.eu (EU) or api-console.zoho.com (US).
Click Add Client (or Get Started) and choose Self Client.
Open the Client Secret tab and copy the Client ID and Client Secret. Store them somewhere safe.

Find your Organization ID

In Zoho Desk, go to Setup > Developer Space > API. The Organization ID is shown on that page.

Create the source in Kleene

Enter the following:

Data Center: Select your region.
Organization ID: The numeric ID from the step above.
Client ID: The Client ID of your Self Client.
Client Secret: The Client Secret of your Self Client.

Features

Feature	Support	Notes
Backfill	✅	Backfill between 1 month and 5 years is supported for the Tickets, Ticket Comments and Ticket Approvals reports.
Incremental	✅	Incremental is supported for the Tickets, Ticket Comments and Ticket Approvals reports.
API reliability	🟢	Reliable

Reports detail

⬇️ Report	🔑 Incremental key	🔑 Primary key	📄 Link to API endpoint
Tickets	`MODIFIED_TIME`	`ID`	Search Tickets
Ticket Comments	`TICKET_MODIFIED_TIME`	`ID`	List all ticket comments
Ticket Approvals	`TICKET_MODIFIED_TIME`	`ID`	List approvals
Contacts	-	`ID`	List contacts
Accounts	-	`ID`	List accounts
Agents	-	`ID`	List agents
Teams	-	`ID`	List teams
Roles	-	`ID`	List roles
Profiles	-	`ID`	List profiles
Help Center Users	-	`ID`	List help center users

Load methods

Tickets, Ticket Comments and Ticket Approvals are incremental. Use the Append load method. Each run fetches tickets modified since the latest MODIFIED_TIME already in your table, plus the comments and approvals of those tickets.
All other reports return the full dataset on every run. Use Drop, Create, Load or Truncate, Load.

Limitations

🚧
Duplicate rows on incremental reports
A ticket that is updated again is loaded again on a later run, and the boundaries of consecutive runs overlap slightly. Incremental tables will therefore contain more than one row per ticket, comment or approval. Deduplicate downstream on ID, keeping the row with the latest MODIFIED_TIME (or TICKET_MODIFIED_TIME for comments and approvals).

🚧
Ticket volume per day
Zoho's ticket search returns at most 5,000 results per query. The connector fetches tickets one day at a time, so it supports up to 5,000 modified tickets per day. Tickets beyond that on a single day will not be extracted.

🚧
API credits and backfill time
Zoho Desk limits API usage with a daily credit allowance that depends on your edition and number of users. Ticket Comments and Ticket Approvals make one API call per modified ticket, so a long backfill on these reports can take several hours and use a large share of your daily credits. Check your usage under Setup > Developer Space > APIs in Zoho Desk.