Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Zoho Desk

Scalekit connector
Open markdown

The Zoho Desk connector lets your AI agent act in each user's Zoho Desk account. Each user signs in to Zoho Desk once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 27 tools.

Tools
27
What they doRead · write · destructive
19 · 8 · 019 read8 write0 destructive
Users sign in with
OAuth app
Your own Zoho Desk app

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Zoho Desk connection

    In AgentKit > Connections, create a Zoho Desk connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

  4. Register an OAuth app

    Zoho Desk connections use your own OAuth app. Register one with Zoho Desk and add the redirect URI you copied.

    Then enter the app's Client ID and Client Secret on the Zoho Desk connection.

  5. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'zohodesk'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Zoho Desk:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'zohodesk_organizations_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • zohodesk_account_getGet one Zoho Desk account (customer company) by ID.Read-only

    Get Account

    Get one Zoho Desk account (customer company) by ID. Returns the full account: id, accountName, email, phone, website, industry, address fields, ownerId, custom fields (cf) and webUrl. Use this when you have an account ID. Use zohodesk_account_tickets_list for the account's tickets. Requires an org_id from zohodesk_organizations_list.

    Inputs

    account_idstringrequired
    ID of the account. Get it from zohodesk_accounts_search or zohodesk_accounts_list (id field). Example: 1892000000975382
    org_idstringrequired
    ID of the Zoho Desk organization (help desk portal) to act on, sent as the orgId header. Get it from zohodesk_organizations_list (id field). Example: 2389290
    includestring
    Set to owner to add the account owner's details. Example: ownerone of owner
  • zohodesk_account_tickets_listList the tickets raised by contacts of one Zoho Desk account (customer company).Read-only

    List Account Tickets

    List the tickets raised by contacts of one Zoho Desk account (customer company). Returns a data array of tickets, each with id, ticketNumber, subject, status, priority, contactId and createdTime. Use this for a company's ticket history. Use zohodesk_contact_tickets_list for one person's tickets. Requires an org_id from zohodesk_organizations_list.

    Inputs

    account_idstringrequired
    ID of the account. Get it from zohodesk_accounts_search or zohodesk_accounts_list (id field). Example: 1892000000975382
    org_idstringrequired
    ID of the Zoho Desk organization (help desk portal) to act on, sent as the orgId header. Get it from zohodesk_organizations_list (id field). Example: 2389290
    department_idstring
    ID of the department to list tickets from. Leave empty for all. Example: 1892000000082069
    due_datestring
    Only tickets due in this window, comma-separated: overdue, today, tomorrow, currentWeek, currentMonth. Example: overdue
    frominteger
    Zero-based index of the first ticket to return, for paging. Example: 0 for the first page, 50 for the second page of 50.
    includestring
    Related data to add, comma-separated: contacts, products, departments, team, isRead, assignee. Example: assignee,departments
    is_spamboolean
    true to return only spam tickets. Defaults to false. Example: false
    limitinteger
    Number of tickets to return, between 1 and 100. Example: 50
    sort_bystring
    Sort field: createdTime or modifiedTime. Prefix with - for descending order. Example: -createdTimeone of createdTime-createdTimemodifiedTime-modifiedTime
  • zohodesk_accounts_listList accounts (customer companies) in a Zoho Desk organization, sorted and paged.Read-only

    List Accounts

    List accounts (customer companies) in a Zoho Desk organization, sorted and paged. Returns a data array of accounts, each with id, accountName, email, phone, website and createdTime. Use this to browse accounts. Use zohodesk_accounts_search to find an account by name, and zohodesk_account_get for one account's full record. Requires an org_id from zohodesk_organizations_list.

    Inputs

    org_idstringrequired
    ID of the Zoho Desk organization (help desk portal) to act on, sent as the orgId header. Get it from zohodesk_organizations_list (id field). Example: 2389290
    frominteger
    Zero-based index of the first account to return, for paging. Example: 0 for the first page, 50 for the second page of 50.
    limitinteger
    Number of accounts to return, between 1 and 100. Example: 50
    sort_bystring
    Sort field: accountName or createdTime. Prefix with - for descending order. Default order is ascending. Example: accountNameone of accountName-accountNamecreatedTime-createdTime
    view_idstring
    ID of a saved account view to apply. Example: 1892000000004563
  • zohodesk_agents_listList agents (help desk staff) in a Zoho Desk organization, optionally filtered by status, department or a name/email search.Read-only

    List Agents

    List agents (help desk staff) in a Zoho Desk organization, optionally filtered by status, department or a name/email search. Returns a data array of agents, each with id, firstName, lastName, emailId, status, roleId and associatedDepartmentIds. Use this to find an assignee_id for a ticket. Use zohodesk_current_agent_get for the connected user's own agent record. Requires an org_id from zohodesk_organizations_list.

    Inputs

    org_idstringrequired
    ID of the Zoho Desk organization (help desk portal) to act on, sent as the orgId header. Get it from zohodesk_organizations_list (id field). Example: 2389290
    department_idsstring
    Comma-separated department IDs (up to 50) to return only agents in those departments. Get IDs from zohodesk_departments_list. Example: 1892000000082069,1892000000082085
    frominteger
    Zero-based index of the first agent to return, for paging. Example: 0 for the first page, 50 for the second page of 50.
    limitinteger
    Number of agents to return, between 1 and 200. Defaults to 10. Example: 50
    search_strstring
    Text to match against agent first name, last name or email. End with * for starts-with, wrap in * for contains, or give the exact value. Example: jade*
    statusstring
    Filter by agent activation status. One of ACTIVE, DISABLED, DELETED, IMPORTED. Example: ACTIVEone of ACTIVEDISABLEDDELETEDIMPORTED
  • zohodesk_contact_getGet one Zoho Desk contact by ID.Read-only

    Get Contact

    Get one Zoho Desk contact by ID. Returns the full contact: id, firstName, lastName, email, secondaryEmail, phone, mobile, address fields, accountId, ownerId, custom fields (cf) and webUrl. Use this when you have a contact ID. Use zohodesk_contact_tickets_list for the contact's tickets. Requires an org_id from zohodesk_organizations_list.

    Inputs

    contact_idstringrequired
    ID of the contact. Get it from zohodesk_contacts_search or zohodesk_contacts_list (id field). Example: 1892000000042032
    org_idstringrequired
    ID of the Zoho Desk organization (help desk portal) to act on, sent as the orgId header. Get it from zohodesk_organizations_list (id field). Example: 2389290
    includestring
    Related data to add, comma-separated: accounts, owner. Example: accounts,owner
  • zohodesk_contact_tickets_listList the tickets raised by one Zoho Desk contact.Read-only

    List Contact Tickets

    List the tickets raised by one Zoho Desk contact. Returns a data array of tickets, each with id, ticketNumber, subject, status, priority, departmentId and createdTime. Use this for a customer's ticket history. Use zohodesk_account_tickets_list for every ticket from a company. Requires an org_id from zohodesk_organizations_list.

    Inputs

    contact_idstringrequired
    ID of the contact. Get it from zohodesk_contacts_search or zohodesk_contacts_list (id field). Example: 1892000000042032
    org_idstringrequired
    ID of the Zoho Desk organization (help desk portal) to act on, sent as the orgId header. Get it from zohodesk_organizations_list (id field). Example: 2389290
    department_idstring
    ID of the department to list tickets from. Leave empty for all. Example: 1892000000082069
    due_datestring
    Only tickets due in this window, comma-separated: overdue, today, tomorrow, currentWeek, currentMonth. Example: overdue
    frominteger
    Zero-based index of the first ticket to return, for paging. Example: 0 for the first page, 50 for the second page of 50.
    includestring
    Related data to add, comma-separated: products, departments, team, isRead, assignee. Example: assignee,departments
    is_spamboolean
    true to return only spam tickets. Defaults to false. Example: false
    limitinteger
    Number of tickets to return, between 1 and 100. Example: 50
    sort_bystring
    Sort field: createdTime or modifiedTime. Prefix with - for descending order. Example: -createdTimeone of createdTime-createdTimemodifiedTime-modifiedTime
  • zohodesk_contacts_listList contacts (customers) in a Zoho Desk organization, sorted and paged.Read-only

    List Contacts

    List contacts (customers) in a Zoho Desk organization, sorted and paged. Returns a data array of contacts, each with id, firstName, lastName, email, phone, accountId and createdTime. Use this to browse contacts. Use zohodesk_contacts_search to find a contact by name, email or phone, and zohodesk_contact_get for one contact's full record. Requires an org_id from zohodesk_organizations_list.

    Inputs

    org_idstringrequired
    ID of the Zoho Desk organization (help desk portal) to act on, sent as the orgId header. Get it from zohodesk_organizations_list (id field). Example: 2389290
    frominteger
    Zero-based index of the first contact to return, for paging. Example: 0 for the first page, 50 for the second page of 50.
    includestring
    Set to accounts to add each contact's account details. Example: accountsone of accounts
    limitinteger
    Number of contacts to return, between 1 and 100. Example: 50
    sort_bystring
    Sort field: firstName, lastName or createdTime. Prefix with - for descending order. Default order is ascending. Example: -createdTimeone of firstName-firstNamelastName-lastNamecreatedTime-createdTime
    view_idstring
    ID of a saved contact view to apply. Example: 1892000000004503