Reference · Credentials

Zendesk API credentials

Used by 2 BusyBot nodes.

Type zendeskApi 3 fields

The Zendesk credential needs three values that work as a set: your subdomain, the email address of a Zendesk agent, and an API token. Zendesk authenticates on the email and token together, so a token alone is never enough.

Fields

FieldTypeRequiredNotes
Subdomain
subdomain
string Yes The subdomain of your Zendesk environment
Email
email
string Yes The email address of the Zendesk user
API Token
apiToken
password Yes Your Zendesk API token.

Getting your credentials

  1. Sign in to Zendesk as an administrator.
  2. Open the Admin Center, go to Apps and integrations → APIs → Zendesk API, and make sure Token access is enabled. It is off by default.
  3. Add an API token, give it a description, and copy it immediately — it is shown once.
  4. Set Subdomain to just the subdomain portion of your Zendesk URL: for https://acme.zendesk.com, enter acme.
  5. Set Email to the address of the Zendesk agent whose permissions the automation should use.
  6. Paste the token into API Token.

Permissions and scopes

The credential acts as the agent whose email is supplied, with that agent’s role and any restrictions on it. A light agent or restricted role cannot do through the API what it cannot do in the interface. Use a dedicated automation agent rather than a personal account.

Troubleshooting

  • 401 Couldn’t authenticate you — token access is disabled in Admin Center, the email does not belong to an active agent, or the token was revoked.
  • 404 on every call — the subdomain field contains the full URL rather than just the subdomain.
  • 403 on an action — the agent’s role does not permit it.
  • Ticket created by the wrong person — tickets are attributed to the agent whose email is on the credential.

Frequently asked questions

Why does my brand new token fail?

Token access has to be enabled in Admin Center under Apps and integrations → APIs → Zendesk API. It is off by default, so tokens exist but do not authenticate until it is switched on.

What exactly goes in Subdomain?

Just the subdomain — `acme` for `https://acme.zendesk.com`. Pasting the full URL causes every request to 404.

Why is an email required as well?

Zendesk authenticates on the agent email and token as a pair, which is also what determines whose permissions apply and who tickets are attributed to.

Should I use my own account?

Better to create a dedicated automation agent, so activity is attributable and access can be revoked without affecting a person's login.

Nodes that use Zendesk API

One credential works across every node below — create it once and reuse it.

Last updated . Spotted something wrong? Tell us.