Zendesk
Read and update Zendesk tickets, users and organizations in your Zendesk Support account.
Connect it with: Sign in (OAuth), User name and password. Zendesk's own documentation: https://developer.zendesk.com/api-reference/introduction/security-and-auth/.
What agents can do
Connect Zendesk so the agents working your tasks can reach it. With it connected, they can:
- Search tickets and read their comments, for example every urgent ticket waiting on your team.
- Reply to tickets with public or internal comments, and change status, priority, assignee or tags.
- Look up and update end users and organizations.
- Read help center articles to draft answers from your own documentation.
Before you start
- A Zendesk Support account and a Zendesk admin who can turn on token access and create an API token.
- A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.
Connect with Zendesk
This is the quickest way in: you sign in to Zendesk and approve what Jaah asks for. You never copy a key.
- In Jaah, open Secrets and select New.
- Search for Zendesk and select its card.
- Give the secret a name you will recognize, such as the account or workspace it reaches, and choose who can use it (see Who can use it).
- Select Connect Zendesk. Zendesk's sign-in window opens.
- Sign in to Zendesk if asked, check the access listed, and approve it.
- You land back in Jaah on the new secret, which reads Connected once its test passes.
If the button reads Jaah app not configured, this Jaah has no app registered at Zendesk yet. Use an API key, or your own OAuth app, until it does.
Scopes Jaah requests
Jaah asks Zendesk for these scopes, and no others. A scope marked optional is a checkbox on the Connect screen: untick it and agents simply cannot do that part.
| Scope | Why Jaah asks for it | Required |
|---|---|---|
read | Read tickets, users, organizations and help center articles | Yes |
write | Reply to and update tickets, users and organizations | Yes |
Connect with an API key
Prefer this when you cannot sign in with Zendesk — for example a service account, or a token your admin issued. On the Connect screen select Use an API key instead.
Find each value first:
- Subdomain: The first part of your Zendesk address: for acme.zendesk.com enter acme.
- Agent email: The email the Zendesk agent or admin signs in with; agents act as this user.
- API token: In Zendesk Admin Center, open Apps and integrations > APIs > Zendesk API, turn on Token access on the Settings tab, select Add API token, describe it as Jaah, and copy the token before saving (Zendesk shows it once).
Then add it to Jaah:
- In Jaah, open Secrets, select New, and pick the Zendesk card.
- Name the secret and choose who can use it.
- Select Use an API key instead.
- Fill in Subdomain, Agent email, API token.
- Select Save. Jaah tests the secret straight away (see Test the connection).
Jaah encrypts what you type and never shows it again — not to you, and not to an admin.
Use your own OAuth app
Register your own OAuth app at Zendesk when your company requires apps it controls, or before this Jaah has an app registered there.
- Create an OAuth app in Zendesk's developer console, https://apps.zendesk.com/ (Zendesk's documentation).
- Set its redirect URI to
https://app.jaah.ai/api/credentials/connect/callback(on your own Jaah, its console address followed by/api/credentials/connect/callback). - Give it the scopes in Scopes Jaah requests.
- Copy its client ID and client secret.
- In Jaah, start a new Zendesk secret, select Use your own OAuth app, paste both values and select Connect Zendesk.
The client secret is stored with the connection, encrypted, like any other secret value.
Test the connection
Select Test on the secret. Jaah calls Zendesk's API once (GET https://<Subdomain>.zendesk.com/api/v2/users/me.json) with the stored values, and shows who it answered as, or which value Zendesk refused and the status it answered. Jaah also tests automatically when you save or reconnect.
The last result and its time stay on the secret's page, so you can see whether it still works without testing again.
Who can use it
Every secret has an owner, and the owner decides who can use it:
- Personal — only your own tasks can use it. This is the default.
- Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
- Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.
More on owners and access: How secrets work.
Use it in an agent session
An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:
org/<name>for an organization secret,projects/<project>/<name>for one attached to a project,me/<name>for your personal one.
A signed-in connection hands the agent a live access_token, with access_token_expires_at. Jaah refreshes it before it expires, so an agent never handles a refresh token.
A key connection hands the agent its fields: subdomain, email, api_token.
Tell the agent in your task description which secret to use, for example “use the Zendesk secret org/zendesk”.
Manage, rotate or disconnect
Everything is on the secret's page under Secrets:
- Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Zendesk once the test passes. Steps: Replace or delete a secret.
- Reconnect: when Zendesk ends the grant (a password change, a revoked app, an expired refresh), the secret shows Needs reconnect. Select Reconnect and sign in again; agents get the new token on their next call.
- Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Zendesk's side too, revoke Jaah in Zendesk's settings, or change the password at Zendesk or remove the user.
Limitations
- An API token is account-wide: with it, the agent email can be any agent's, so keep the secret's audience small.
- Connect signs in at your account's own address, so it asks for your subdomain first; agents then act as the person who signed in, with that person's role.
- Zendesk rate-limits by plan (for example 400 requests a minute on Suite Professional), shared by every integration.
- Agents send
<email>/tokenas the Basic user name and the API token as the password, as Zendesk requires. - Agents can do only what the connected Zendesk account and its granted scopes allow.
Troubleshooting
Test says Zendesk rejected the API token (401)
The token was deleted, token access is turned off, or the email is not an agent or admin. In Admin Center > Apps and integrations > APIs > Zendesk API check Token access is on and the token is listed, then select Replace on the secret.
Test says Zendesk cannot be reached at that address
The subdomain is wrong. Enter only the first part of your address, for acme.zendesk.com enter acme, with no https:// and no .zendesk.com.
The Zendesk window says the client is invalid
Jaah's Zendesk client is not approved for other accounts yet. Connect with an API token until it is.
An agent gets 403 Forbidden on a ticket
The agent email's role cannot see that ticket's group or brand. Use an email whose role has access, or widen the role in Admin Center > People > Team > Roles.
Still stuck? Select Test and read the result: it names the value Zendesk refused and the status it answered.
FAQ
Does Zendesk support a host-mapped domain like support.acme.com?
Enter the zendesk.com subdomain, not the mapped domain: the API is always served at SUBDOMAIN.zendesk.com.
Zendesk calls API tokens deprecated - will this stop working?
Zendesk recommends OAuth, which Connect uses, but still serves API tokens.
Can Jaah or an admin see the key or token?
No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.
Can I connect more than one Zendesk account?
Yes. Add one secret per account, each with its own name, and tell the agent which one to use.