Skip to main content

Zendesk Talk

Prerequisites​

  • A Zendesk account on a plan that includes the Zendesk Talk add-on
  • Your Zendesk subdomain (for example, if your Zendesk URL is https://mycompany.zendesk.com, the subdomain is mycompany)
  • One of the following authentication methods:
    • OAuth 2.0 (recommended): A Zendesk OAuth client with a client ID, client secret, and refresh token
    • API Token: A Zendesk API token and the email address associated with the token. Zendesk disables new API token creation on October 27, 2026.

Setup guide​

Step 1: Set up Zendesk​

Choose one of the following authentication methods:

API Token​

caution

Zendesk is removing API tokens as an authentication method. Starting October 27, 2026, Zendesk accounts can't create new API tokens, so you can only use API Token authentication with an active token you already have. Zendesk also deactivates any token that goes unused for 30 days. On April 30, 2027, Zendesk permanently deactivates all remaining API tokens, and sources that use them stop syncing. Set up new sources with OAuth 2.0, and switch existing API token sources to OAuth before April 30, 2027.

Generate an API token in your Zendesk Admin Center under Apps and integrations > APIs > Zendesk API. For details, see Managing API token access to the Zendesk API in the Zendesk documentation. We recommend creating a token specifically for Airbyte access. After October 27, 2026, Zendesk doesn't let you create new tokens, so these steps only work before that date.

OAuth 2.0​

Register an OAuth client in your Zendesk Admin Center under Apps and integrations > APIs > OAuth Clients. For details, see Using OAuth authentication with your application in the Zendesk documentation. Zendesk uses rotating refresh tokens, so each token refresh returns a new refresh token and invalidates the previous one.

OAuth token lifetimes​

For the OAuth 2.0 refresh-token flow, the connector requests access tokens with expires_in=172800 (2 days), both during authorization and when refreshing a token. Zendesk's grant-type token API supports refresh-token lifetimes from 7 to 90 days, with a default of 30 days. The connector does not set refresh_token_expires_in, so it uses that default when requesting tokens.

Each refresh invalidates the previous access token and refresh token. If your refresh token expires, obtain new OAuth credentials before resuming syncs.

Step 2: Set up the Zendesk Talk connector in Airbyte​

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + New source.
  3. Select Zendesk Talk from the Source type dropdown.
  4. Enter your Subdomain.
  5. Choose your Authentication method and enter the required credentials. Use OAuth 2.0 unless you already have an active API token.
  6. Set a Start Date for incremental streams. Data created or updated after this date is replicated.
  7. Click Set up source.

Supported sync modes​

The Zendesk Talk source connector supports the following sync modes:

  • Full Refresh
  • Incremental Sync

Supported streams​

This connector syncs the following streams:

Performance considerations​

The connector respects the Zendesk Talk API rate limits. The Talk API enforces the following limits in addition to the standard Zendesk Support API limits:

EndpointRate limit
All Talk API endpoints15,000 requests per 5 minutes
Current Queue Activity2,500 requests per 5 minutes
Incremental Exports (Calls, Call Legs)10 requests per minute

The connector automatically handles rate limiting by respecting 429 responses and the Retry-After header. Under normal usage, you should not encounter rate limit issues. If you do, create an issue.

Subscription plan​

Set Subscription Plan/Tier to match your Zendesk plan. If you are unsure, leave the default, Team, for the most conservative limit. The connector configures its request budget as follows:

  • Team: 200 requests per minute
  • Growth: 400 requests per minute
  • Professional: 400 requests per minute
  • Enterprise: 700 requests per minute
  • Enterprise Plus: 2,500 requests per minute

These are the connector's configured budgets, not a guarantee of available API capacity. The Zendesk Support API limits also apply to Talk API requests, in addition to the endpoint limits above.

Data type map​

Integration TypeAirbyte Type
stringstring
numbernumber
arrayarray
objectobject

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
string
start_date
string
subdomain
object
credentials
string
subscription_tier

Changelog​

Expand to review
VersionDatePull RequestSubject
2.0.362026-11-1091795Update dependencies
2.0.352026-11-0390906Simplify rate-limit and retry error handling configuration with no change in behavior
2.0.342026-11-0390809Update dependencies
2.0.332026-10-2790071Update dependencies
2.0.322026-10-2089478Update dependencies
2.0.312026-10-1388855Update dependencies
2.0.302026-10-0688101Update dependencies
2.0.292026-09-2987435Update dependencies
2.0.282026-09-2286870Update dependencies
2.0.272026-09-1586299Update dependencies
2.0.262026-09-0885734Update dependencies
2.0.252026-08-1884810Update dependencies
2.0.242026-08-1183814Persist OAuth token expiry on initial authentication so the first sync no longer refreshes and rotates away the single-use refresh token
2.0.232026-08-1184187Update dependencies
2.0.222026-07-2883194Update to CDK 7.23.8 (fixes AirbyteCustomCodeNotPermittedError for bundled custom components) and remove the temporary Cloud version override
2.0.212026-07-281082Roll Cloud back to 2.0.19 — 2.0.20 is built on SDM 7.23.7, which breaks bundled custom components
2.0.202026-07-2883181Update dependencies
2.0.192026-07-2182651Update dependencies
2.0.182026-07-1482090Update dependencies
2.0.172026-07-1081516Fix infinite pagination loop on call_legs and calls incremental streams
2.0.162026-06-3081319Update dependencies
2.0.152026-06-2380706Update dependencies
2.0.142026-06-1680118Update dependencies
2.0.132026-06-0979570Update dependencies
2.0.122026-06-0276832Update dependencies
2.0.112026-04-3077647Promoted release candidate to GA
2.0.11-rc.52026-04-2477007Add subscription_tier config field and re-enable HTTPAPIBudget as dynamic tier-based budget for tuning iteration 5
2.0.11-rc.42026-04-2276872Decrease default_concurrency from 6 to 4 and comment out HTTPAPIBudget for tuning iteration 4
2.0.11-rc.32026-04-1776449Decrease default_concurrency from 9 to 6 for tuning iteration 3
2.0.11-rc.22026-04-1376266Decrease default_concurrency from 12 to 9 for tuning iteration 2
2.0.11-rc.12026-04-1076203Add concurrency support with default_concurrency of 12
2.0.102026-04-0776106Add token_expiry_date to complete_oauth_output_specification so it is hidden from the UI as an OAuth-managed field
2.0.92026-03-3175808Update dependencies
2.0.82026-03-1174395Migrate to scopes object array format
2.0.72026-03-1074446Update dependencies
2.0.62026-02-2473990Update dependencies
2.0.52026-02-1773506Update dependencies
2.0.42026-02-1072070Update dependencies
2.0.32026-02-0372782Upgrade CDK version to 7.8.1
2.0.22026-01-2872424Update breaking change deadline from Jan 31 to Jan 30
2.0.12026-01-2772383Fix OAuth race condition with concurrent token refresh
2.0.02026-01-2171857Add OAuth2.0 with refresh token support. Users who authenticate via OAuth must re-authenticate.
1.2.292026-01-1471686Update dependencies
1.2.282025-12-1870683Update dependencies
1.2.272025-11-2570102Update dependencies
1.2.262025-11-1869569Update dependencies
1.2.252025-10-2968944Update dependencies
1.2.242025-10-2268591Add suggestedStreams
1.2.232025-10-2168411Update dependencies
1.2.222025-10-1467991Update dependencies
1.2.212025-10-0767246Update dependencies
1.2.202025-09-3066855Update dependencies
1.2.192025-09-2466473Update dependencies
1.2.182025-09-0965721Update dependencies
1.2.172025-08-2465426Update dependencies
1.2.162025-08-1064871Update dependencies
1.2.152025-08-0264320Update dependencies
1.2.142025-07-2764081Update dependencies
1.2.132025-07-1963611Update dependencies
1.2.122025-07-1263180Update dependencies
1.2.112025-07-0562730Update dependencies
1.2.102025-06-2862224Update dependencies
1.2.92025-06-2161753Update dependencies
1.2.82025-06-1561223Update dependencies
1.2.72025-05-2460770Update dependencies
1.2.62025-05-1059917Update dependencies
1.2.52025-05-0458933Update dependencies
1.2.42025-04-1958541Update dependencies
1.2.32025-04-1358053Update dependencies
1.2.22025-04-0556838Update dependencies
1.2.12025-03-2248245Update dependencies
1.2.02025-02-0750956Restore Unit Test
1.1.0-rc.12024-10-3147313Migrate to Manifest-only
1.0.212024-10-2947082Update dependencies
1.0.202024-10-1246861Update dependencies
1.0.192024-10-0546394Update dependencies
1.0.182024-09-2846149Update dependencies
1.0.172024-09-2145783Update dependencies
1.0.162024-09-1445524Update dependencies
1.0.152024-09-0745301Update dependencies
1.0.142024-08-3145019Update dependencies
1.0.132024-08-2444624Update dependencies
1.0.122024-08-1744214Update dependencies
1.0.112024-08-1043558Update dependencies
1.0.102024-08-0343203Update dependencies
1.0.92024-07-2742669Update dependencies
1.0.82024-07-2042328Update dependencies
1.0.72024-07-1341727Update dependencies
1.0.62024-07-1041350Update dependencies
1.0.52024-07-0941119Update dependencies
1.0.42024-07-0640855Update dependencies
1.0.32024-06-2540278Update dependencies
1.0.22024-06-2240056Update dependencies
1.0.12024-06-0439036[autopull] Upgrade base image to v1.2.1
1.0.02024-05-0635780Migrate implementation to low-code CDK
0.2.12024-05-0236625Schema descriptions and CDK 0.80.0
0.2.02024-03-2536459Unpin CDK version, add record counts in state messages
0.1.132024-03-0435783Change order of authentication methods in spec
0.1.122024-02-1235156Manage dependencies with Poetry.
0.1.112024-01-1234204Prepare for airbyte-lib
0.1.102023-12-0433030Base image migration: remove Dockerfile and use python-connector-base image
0.1.92023-08-0329031Reverted advancedAuth spec changes
0.1.82023-08-0128910Updated advancedAuth broken references
0.1.72023-02-1022815Specified date formatting in specification
0.1.62023-01-2722028Set AvailabilityStrategy for streams explicitly to None
0.1.52022-09-2917362always use the latest CDK version
0.1.42022-08-1915764Support OAuth2.0
0.1.32021-11-117173Fix pagination and migrate to CDK