Zoho Desk

Zoho Desk is Zoho's customer support help desk. Support teams use it to receive tickets from email, web forms, chat, phone, and social channels, route them to the right department and agent, and track every customer conversation through to resolution.

With the Sim Zoho Desk integration, you can:

  • Read and filter tickets: List tickets across an organization filtered by department, status, or priority, or fetch a single ticket by ID with its related contact, assignee, and department.
  • Update tickets: Change subject, status, priority, assignee, department, category, due date, and custom fields — useful for AI triage that classifies an incoming ticket and writes the result back.
  • Work with conversations: List and read ticket threads (the customer-facing email/chat exchange) and comments (internal agent notes), then add your own comment as public or private.
  • Look up contacts: Retrieve the contact behind a ticket to enrich it with data from your CRM or knowledge base.
  • Download attachments: Pull an attachment from a thread or comment into a Sim file you can pass to downstream blocks.
  • Trigger on events: Start a workflow when a ticket, comment, thread, contact, agent, task, or article changes in Zoho Desk.

How it works in Sim: Add a Zoho Desk block to your workflow, connect your Zoho account, and pick the Organization (portal) to work in — Sim loads the list for you from the connected account. Choose an operation and fill in its parameters; the block calls the Zoho Desk API and returns structured data for downstream blocks. For comment and thread bodies, Sim adds a derived plain-text contentText field alongside Zoho's raw HTML content, so an AI agent can read the message without HTML markup.

To trigger on Zoho Desk activity instead, use the block's trigger mode. Sim creates the webhook subscription in Zoho Desk for you and removes it automatically when the workflow is undeployed.

Requirements and limitations

Zoho Desk webhooks require a Zoho Desk edition of Professional or higher — Free and Standard plans cannot create webhook subscriptions, so the trigger will fail to deploy on those plans.

Connecting a Zoho account with OAuth — which the trigger requires — works only for the US data center (accounts.zoho.com). To use Zoho Desk blocks from the EU, India, or Australia data centers, connect a Self Client instead and set its data center. The Japan, Canada, Saudi Arabia, China, and UK data centers are not supported by either path.

Usage Instructions

Read and update Zoho Desk tickets, manage comments and threads, look up contacts, and download attachments. Can also trigger workflows from Zoho Desk webhook events.

Actions

zoho_desk_list_tickets

List tickets from a Zoho Desk organization with optional filters. Returns a list projection: description, resolution, statusType and classification are only available from Get Ticket.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
fromnumberNoPagination start index (0-based, max 4999)
limitnumberNoNumber of tickets to return (1-100, default 10)
departmentIdsstringNoFilter by department ID (comma-separated for multiple)
statusstringNoFilter by status, including custom statuses. Comma-separate to match multiple (e.g. "Open,On Hold")
prioritystringNoFilter by priority. Comma-separate to match multiple (e.g. "High,Urgent")
sortBystringNoSort field: createdTime, customerResponseTime, or responseDueDate. Prefix with - for descending.
includestringNoComma-separated related data to embed. Allowed: contacts, products, departments, team, isRead, assignee

Output

ParameterTypeDescription
ticketsarrayList of tickets
idstringTicket ID
ticketNumberstringHuman-readable ticket number
subjectstringTicket subject
descriptionstringTicket description (raw; may be HTML)
descriptionTextstringPlain-text rendering of the description: HTML stripped when the body contains markup, otherwise the description verbatim
statusstringTicket status
statusTypestringStatus category (Open/Closed/On Hold)
prioritystringTicket priority
categorystringTicket category
subCategorystringTicket sub-category
classificationstringTicket classification
channelstringOrigin channel
departmentIdstringDepartment ID
contactIdstringContact ID
accountIdstringAccount ID
assigneeIdstringAssignee ID
emailstringContact email
phonestringContact phone
dueDatestringDue date
responseDueDatestringResponse due date
createdTimestringCreated timestamp
modifiedTimestringLast modified timestamp
closedTimestringClosed timestamp
resolutionstringResolution text
threadCountstringNumber of threads
commentCountstringNumber of comments
webUrlstringWeb URL to the ticket
isEscalatedbooleanWhether the ticket is escalated
isOverDuebooleanWhether the ticket is overdue
isSpambooleanWhether the ticket is marked spam
cfjsonCustom field values, keyed by custom field API name
countnumberNumber of tickets returned

zoho_desk_get_ticket

Retrieve a single Zoho Desk ticket by ID.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
ticketIdstringYesTicket ID to retrieve
includestringNoComma-separated related data to embed. Allowed: contacts, products, assignee, departments, contract, isRead, team, skills

Output

ParameterTypeDescription
ticketobjectThe ticket
idstringTicket ID
ticketNumberstringHuman-readable ticket number
subjectstringTicket subject
descriptionstringTicket description (raw; may be HTML)
descriptionTextstringPlain-text rendering of the description: HTML stripped when the body contains markup, otherwise the description verbatim
statusstringTicket status
statusTypestringStatus category (Open/Closed/On Hold)
prioritystringTicket priority
categorystringTicket category
subCategorystringTicket sub-category
classificationstringTicket classification
channelstringOrigin channel
departmentIdstringDepartment ID
contactIdstringContact ID
accountIdstringAccount ID
assigneeIdstringAssignee ID
emailstringContact email
phonestringContact phone
dueDatestringDue date
responseDueDatestringResponse due date
createdTimestringCreated timestamp
modifiedTimestringLast modified timestamp
closedTimestringClosed timestamp
resolutionstringResolution text
threadCountstringNumber of threads
commentCountstringNumber of comments
webUrlstringWeb URL to the ticket
isEscalatedbooleanWhether the ticket is escalated
isOverDuebooleanWhether the ticket is overdue
isSpambooleanWhether the ticket is marked spam
cfjsonCustom field values, keyed by custom field API name

zoho_desk_update_ticket

Update fields on an existing Zoho Desk ticket.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
ticketIdstringYesTicket ID to update
subjectstringNoTicket subject
statusstringNoTicket status (e.g. Open, Closed)
prioritystringNoTicket priority (e.g. High)
assigneeIdstringNoAssignee (agent) ID
departmentIdstringNoDepartment ID
categorystringNoTicket category
subCategorystringNoTicket sub-category
dueDatestringNoDue date (ISO 8601)
descriptionstringNoTicket description
resolutionstringNoResolution notes recorded on the ticket
classificationstringNoTicket classification: Problem, Request, Question, or Others
customFieldsjsonNoCustom field values as a JSON object, keyed by custom field API name

Output

ParameterTypeDescription
ticketobjectThe updated ticket
idstringTicket ID
ticketNumberstringHuman-readable ticket number
subjectstringTicket subject
descriptionstringTicket description (raw; may be HTML)
descriptionTextstringPlain-text rendering of the description: HTML stripped when the body contains markup, otherwise the description verbatim
statusstringTicket status
statusTypestringStatus category (Open/Closed/On Hold)
prioritystringTicket priority
categorystringTicket category
subCategorystringTicket sub-category
classificationstringTicket classification
channelstringOrigin channel
departmentIdstringDepartment ID
contactIdstringContact ID
accountIdstringAccount ID
assigneeIdstringAssignee ID
emailstringContact email
phonestringContact phone
dueDatestringDue date
responseDueDatestringResponse due date
createdTimestringCreated timestamp
modifiedTimestringLast modified timestamp
closedTimestringClosed timestamp
resolutionstringResolution text
threadCountstringNumber of threads
commentCountstringNumber of comments
webUrlstringWeb URL to the ticket
isEscalatedbooleanWhether the ticket is escalated
isOverDuebooleanWhether the ticket is overdue
isSpambooleanWhether the ticket is marked spam
cfjsonCustom field values, keyed by custom field API name

zoho_desk_list_comments

List comments on a Zoho Desk ticket.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
ticketIdstringYesTicket ID
fromnumberNoPagination start index (0-based)
limitnumberNoNumber of comments to return (1-100, default 50)

Output

ParameterTypeDescription
commentsarrayList of comments
idstringComment ID
contentstringComment content (raw; may be HTML)
contentTypestringContent type (plainText/html)
contentTextstringPlain-text rendering of content (HTML stripped when contentType is html)
isPublicbooleanWhether the comment is public
commenterIdstringCommenter ID
commenterobjectWho wrote the comment
namestringDisplay name
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
typestringCommenter type (AGENT/END_USER)
roleNamestringRole name
photoURLstringAvatar URL
commentedTimestringCommented timestamp
modifiedTimestringModified timestamp
attachmentsarrayComment attachments
idstringAttachment ID
namestringFile name
sizestringFile size as reported by Zoho
hrefstringDownload href
countnumberNumber of comments returned

zoho_desk_add_comment

Add a comment to a Zoho Desk ticket.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
ticketIdstringYesTicket ID
contentstringYesComment content
contentTypestringNoContent type: plainText or html. Defaults to plainText so agent-written text posts literally; pass 'html' to send markup (Zoho's own API default is html).
isPublicbooleanNoWhether the comment is public

Output

ParameterTypeDescription
commentobjectThe created comment
idstringComment ID
contentstringComment content (raw; may be HTML)
contentTypestringContent type (plainText/html)
contentTextstringPlain-text rendering of content (HTML stripped when contentType is html)
isPublicbooleanWhether the comment is public
commenterIdstringCommenter ID
commenterobjectWho wrote the comment
namestringDisplay name
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
typestringCommenter type (AGENT/END_USER)
roleNamestringRole name
photoURLstringAvatar URL
commentedTimestringCommented timestamp
modifiedTimestringModified timestamp
attachmentsarrayComment attachments
idstringAttachment ID
namestringFile name
sizestringFile size as reported by Zoho
hrefstringDownload href

zoho_desk_list_threads

List conversation threads on a Zoho Desk ticket, newest first (Zoho sorts by sendDateTime descending by default). Returns a list projection: message bodies (content, summary, to/cc/bcc) come back only from Get Thread.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
ticketIdstringYesTicket ID
fromnumberNoPagination start index (0-based)
limitnumberNoNumber of threads to return (1-200, default 100)

Output

ParameterTypeDescription
threadsarrayList of threads
idstringThread ID
channelstringThread channel
directionstringDirection (in/out)
contentstringThread content (raw; may be HTML)
contentTypestringContent type
contentTextstringPlain-text rendering of content (HTML stripped when contentType is html)
summarystringThread summary
responderIdstringResponder ID
createdTimestringCreated timestamp
hasAttachbooleanWhether the thread has attachments
attachmentCountstringNumber of attachments
fromEmailAddressstringFrom email address
tostringTo email address
ccstringCC email address
bccstringBCC email address
replyTostringReply-to email address
isForwardbooleanWhether the thread is a forward
isContentTruncatedbooleanWhether Zoho truncated the thread content; fetch fullContentURL for the rest
fullContentURLstringURL returning the untruncated thread content
plainTextstringZoho's own plain-text rendering of the thread, when it supplies one
statusstringDelivery status of an outgoing thread (SUCCESS/FAILED/DRAFT)
isDescriptionThreadbooleanWhether this thread is the ticket's original description
visibilitystringThread visibility (e.g. public)
canReplybooleanWhether the thread can be replied to
authorobjectWho sent the thread
namestringDisplay name
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
typestringAuthor type (AGENT/END_USER)
photoURLstringAvatar URL
attachmentsarrayThread attachments
idstringAttachment ID
namestringFile name
sizestringFile size as reported by Zoho
hrefstringDownload href
countnumberNumber of threads returned

zoho_desk_get_thread

Retrieve the full content of a single Zoho Desk ticket thread.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
ticketIdstringYesTicket ID
threadIdstringYesThread ID

Output

ParameterTypeDescription
threadobjectThe thread
idstringThread ID
channelstringThread channel
directionstringDirection (in/out)
contentstringThread content (raw; may be HTML)
contentTypestringContent type
contentTextstringPlain-text rendering of content (HTML stripped when contentType is html)
summarystringThread summary
responderIdstringResponder ID
createdTimestringCreated timestamp
hasAttachbooleanWhether the thread has attachments
attachmentCountstringNumber of attachments
fromEmailAddressstringFrom email address
tostringTo email address
ccstringCC email address
bccstringBCC email address
replyTostringReply-to email address
isForwardbooleanWhether the thread is a forward
isContentTruncatedbooleanWhether Zoho truncated the thread content; fetch fullContentURL for the rest
fullContentURLstringURL returning the untruncated thread content
plainTextstringZoho's own plain-text rendering of the thread, when it supplies one
statusstringDelivery status of an outgoing thread (SUCCESS/FAILED/DRAFT)
isDescriptionThreadbooleanWhether this thread is the ticket's original description
visibilitystringThread visibility (e.g. public)
canReplybooleanWhether the thread can be replied to
authorobjectWho sent the thread
namestringDisplay name
firstNamestringFirst name
lastNamestringLast name
emailstringEmail address
typestringAuthor type (AGENT/END_USER)
photoURLstringAvatar URL
attachmentsarrayThread attachments
idstringAttachment ID
namestringFile name
sizestringFile size as reported by Zoho
hrefstringDownload href

zoho_desk_get_contact

Retrieve a Zoho Desk contact by ID.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
contactIdstringYesContact ID to retrieve

Output

ParameterTypeDescription
contactobjectThe contact
idstringContact ID
firstNamestringFirst name
lastNamestringLast name
emailstringPrimary email
secondaryEmailstringSecondary email
phonestringPhone number
mobilestringMobile number
accountIdstringAssociated account ID
ownerIdstringOwner ID
typestringContact type
titlestringJob title
streetstringStreet
citystringCity
statestringState
countrystringCountry
zipstringZIP / postal code
descriptionstringDescription
cfjsonCustom field values, keyed by custom field API name

zoho_desk_get_attachment

Download a Zoho Desk ticket attachment (from its href) as a file.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL
orgIdstringYesZoho Desk organization ID
hrefstringYesAttachment download href (from a thread or comment attachment)
fileNamestringNoOptional file name for the downloaded file

Output

ParameterTypeDescription
filefileThe downloaded attachment file

zoho_desk_list_organizations

List the Zoho Desk organizations (portals) the connected account can access.

Input

ParameterTypeRequiredDescription
apiDomainstringNoZoho Desk data-center REST base URL

Output

ParameterTypeDescription
organizationsarrayAccessible organizations
idstringOrganization ID
companyNamestringCompany name
portalNamestringPortal name
countnumberNumber of organizations returned

Triggers

A Trigger is a block that starts a workflow when an event happens in this service.

Zoho Desk Event

Trigger a workflow when a Zoho Desk event occurs (ticket, comment, thread, contact, agent, task, or article changes).

Configuration

ParameterTypeRequiredDescription
triggerCredentialsstringYesThis trigger creates and manages a webhook subscription in your Zoho Desk account.
orgIdproject-selectorYesThe Zoho Desk organization (portal) to subscribe in.
manualOrgIdstringYesType an organization ID instead of picking one from the list.
eventTypestringYesEvent
triggerDepartmentIdsstringNoRestrict events to these departments. Leave empty for all departments.
fieldsstringNoFor Ticket Updated: only fire when one of these fields changes (max 5). Previous values are included in the payload.
directionstringNoThread Direction

Output

ParameterTypeDescription
eventTypestringThe Zoho Desk event type (e.g. Ticket_Add)
eventTimestringEvent time in milliseconds since epoch
orgIdstringZoho Desk organization ID
payloadjsonThe full resource that changed (ticket, comment, thread, etc.). Comment and thread events gain a derived plain-text contentText alongside the raw content + contentType; ticket events gain descriptionText alongside description.
prevStatejsonPrevious state of the resource (update events only)

On this page