Skip to main content

Zendesk Chat

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable Self-Managed EnterpriseAvailable PyAirbyte
Support Level
Airbyte
Connector Version
1.3.11 (last updated a month ago)
Sync Success Rate
Usage Rate
Data workers used
0.2 per sync (Learn more)
Definition ID
40d24d0f-b8f9-4fe0-9e6c-b06c0f3f45e4

This page contains the setup guide and reference information for the Zendesk Chat source connector.

Prerequisites​

  • (Airbyte Open Source) An access token. See OAuth Authentication for details. We recommend creating a restricted, read-only token specifically for Airbyte access.

Setup guide​

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Zendesk Chat from the Source type dropdown.
  4. Enter the name for the Zendesk Chat connector.
  5. For Subdomain, enter your Zendesk subdomain (for example, if your Zendesk URL is https://mycompany.zendesk.com, enter mycompany).
  6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
  7. Click Authenticate your Zendesk Chat account. Log in and authorize your Zendesk Chat account. The OAuth flow requests read and chat scopes.
  8. Click Set up source.

For Airbyte Open Source:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Zendesk Chat from the Source type dropdown.
  4. Enter the name for the Zendesk Chat connector.
  5. For Subdomain, enter your Zendesk subdomain (for example, if your Zendesk URL is https://mycompany.zendesk.com, enter mycompany).
  6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
  7. For Authorization Method, select Access Token from the dropdown and enter your Zendesk access token. The token must have read scope.
  8. Click Set up source.

Supported sync modes​

The Zendesk Chat source connector supports the following sync modes:

Supported Streams​

Performance considerations​

The Zendesk Chat API enforces a rate limit of 200 requests per minute per endpoint. The connector handles rate limiting automatically by respecting the Retry-After header when a 429 response is returned.

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

Changelog​

Expand to review
VersionDatePull RequestSubject
1.3.122026-06-0279069Update dependencies
1.3.112026-04-2877490Update dependencies
1.3.102026-04-2176846Bump SDM base image to stable 7.17.2
1.3.92026-03-3175942Bump SDM base image for memory monitor (CDK PR #962)
1.3.82026-03-3175858Update dependencies
1.3.72026-03-1774324Migrate to scopes object array format
1.3.62026-03-1775116Update dependencies
1.3.52026-03-1074671Update dependencies
1.3.42026-03-0374156Update dependencies
1.3.32026-02-1773534Update dependencies
1.3.22026-02-1073151Update dependencies
1.3.12026-02-0372611Update dependencies
1.3.02026-01-1771829Add OAuth2.0 support for Airbyte Cloud
1.2.312026-01-2072091Update dependencies
1.2.302026-01-1471701Update dependencies
1.2.292025-12-1870681Update dependencies
1.2.282025-11-2570128Update dependencies
1.2.272025-11-1869513Update dependencies
1.2.262025-10-2968958Update dependencies
1.2.252025-10-2768629Fix Pagination for chats and agent_timeline streams
1.2.242025-10-2268591Add suggestedStreams
1.2.232025-10-2267607Handle 404 errors for deleted records in all streams
1.2.222025-10-2168440Update dependencies
1.2.212025-10-1468020Update dependencies
1.2.202025-10-0767238Update dependencies
1.2.192025-09-3066845Update dependencies
1.2.182025-09-2466459Update dependencies
1.2.172025-09-0965491Update dependencies
1.2.162025-08-1064864Update dependencies
1.2.152025-08-0264305Update dependencies
1.2.142025-07-2664053Update dependencies
1.2.132025-07-2063650Update dependencies
1.2.122025-07-1263177Update dependencies
1.2.112025-07-0562677Update dependencies
1.2.102025-06-2862247Update dependencies
1.2.92025-06-2161751Update dependencies
1.2.82025-06-1561248Update dependencies
1.2.72025-05-2460782Update dependencies
1.2.62025-05-1059993Update dependencies
1.2.52025-05-0458949Update dependencies
1.2.42025-04-1958028Update dependencies
1.2.32025-04-0557404Update dependencies
1.2.22025-03-2956850Update dependencies
1.2.12025-03-2256345Update dependencies
1.2.02025-03-1047319Migrate to Manifest-only
1.1.12025-03-0954110Update dependencies
1.1.02025-03-0354151Migrate to incrementalcursors
1.0.42025-02-0153081Update dependencies
1.0.32025-01-2551942Update dependencies
1.0.22025-01-2252065Pinned airbyte-cdk version to 0.72.2
1.0.12025-01-1143728Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
1.0.02024-11-0444898Migrate to new base url
0.3.12024-06-0639260[autopull] Upgrade base image to v1.2.2
0.3.02024-03-0735867Migrated to YamlDeclarativeSource (Low-code) Airbyte CDK
0.2.22024-02-1235185Manage dependencies with Poetry.
0.2.12023-10-2031643Upgrade base image to airbyte/python-connector-base:1.1.0
0.2.02023-10-1130526Use the python connector base image, remove dockerfile and implement build_customization.py
0.1.142023-02-1024190Fix remove too high min/max from account stream
0.1.132023-02-1022819Specified date formatting in specification
0.1.122023-01-2722026Set AvailabilityStrategy for streams explicitly to None
0.1.112022-10-1817745Add Engagements Stream and fix infity looping
0.1.102022-09-2817326Migrate to per-stream states.
0.1.92022-08-2315879Corrected specification and stream schemas to support backward capability
0.1.82022-06-2813387Add state checkpoint to allow long runs
0.1.72022-05-2512883Pass timeout in request to prevent a stuck connection
0.1.62021-12-157313Add support of OAuth 2.0 authentication. Fixed the issue with created_at can now be null for bans stream
0.1.52021-12-068425Update title, description fields in spec
0.1.42021-11-228166Make Chats stream incremental + add tests for all streams
0.1.32021-10-217210Chats stream is only getting data from first page
0.1.22021-08-175476Correct field unread to boolean type
0.1.12021-06-093973Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.1.02021-05-033088Initial release
Was this page helpful?