Reference

Authentication Token Authentication (Legacy)

Description

Authenticate using Static Token instead of userid / password ([Token Access] option must be enabled under Admin Console > Channel > API > Settings and then Click [ADD API Token] to generate new token. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/settings [API reference]

Instructions

Use API Token authentication to authenticate with your Zendesk user email and a Zendesk API token instead of your password.

Deprecated by Zendesk: Zendesk is removing API token authentication. Existing API tokens are scheduled to stop working on April 30, 2027. For new integrations, use OAuth instead.
  1. Sign in to Zendesk as an administrator.
  2. Go to Admin Center > Apps and integrations > APIs > Zendesk API.
  3. Make sure Token access is enabled.
  4. Create or select an existing API token.
  5. Copy the generated token and store it securely.
  6. Enter your Zendesk Sub Domain.
  7. Enter your Zendesk User ID / Email.
  8. Paste the API token into the Token field.
  9. Click Test Connection.
Migration: For unattended ETL, scheduled jobs, and server-side integrations, use OAuth - Client Credentials (Server-to-Server).

Parameters

Parameter Required Default value Options
Name: Domain

Label: Sub Domain (e.g. mycompany)

 YES
Name: UserId

Label: UserId

 YES
Name: Password

Label: Token

 YES
Name: RetryMode

Label: RetryMode

 RetryWhenStatusCodeMatch
Name Value
None None
RetryAny RetryAny
RetryWhenStatusCodeMatch RetryWhenStatusCodeMatch
Name: RetryStatusCodeList

Label: RetryStatusCodeList

 429
Name: RetryCountMax

Label: RetryCountMax

 5
Name: RetryMultiplyWaitTime

Label: RetryMultiplyWaitTime

 True