Zendesk Chat
Use this page to set up the Zendesk Chat source connector and find reference information.
Prerequisites
- A Zendesk account with the Chat module enabled.
- Your Zendesk subdomain.
- (Airbyte Open Source) An access token. See OAuth Authentication for details. Create a restricted, read-only token specifically for Airbyte access.
Setup
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- Click Sources, then click + New source.
- On the Set up the source page, select Zendesk Chat from the Source type dropdown.
- Enter a name for the Zendesk Chat connector.
- For Subdomain, enter your Zendesk subdomain. For example, if your Zendesk URL is
https://mycompany.zendesk.com, entermycompany. - For Start Date, enter the date in
YYYY-MM-DDTHH:mm:ssZformat. Data added on or after this date will be replicated. - Click Authenticate your Zendesk Chat account. Log in and authorise your Zendesk Chat account. The OAuth flow requests
readandchatscopes. - Click Set up source.
For Airbyte Open Source:
- Go to the Airbyte Open Source dashboard.
- Click Sources, then click + New source.
- On the Set up the source page, select Zendesk Chat from the Source type dropdown.
- Enter a name for the Zendesk Chat connector.
- For Subdomain, enter your Zendesk subdomain. For example, if your Zendesk URL is
https://mycompany.zendesk.com, entermycompany. - For Start Date, enter the date in
YYYY-MM-DDTHH:mm:ssZformat. Data added on or after this date will be replicated. - For Authorization Method, select Access Token from the dropdown. Enter your Zendesk access token. The token must have the
readandchatscopes. - Click Set up source.
Supported sync modes
The Zendesk Chat source connector supports these sync modes:
Supported streams
- Accounts
- Agents (Incremental)
- Agent Timelines (Incremental)
- Chats (Incremental)
- Shortcuts
- Triggers
- Bans (Incremental)
- Departments
- Goals
- Skills
- Roles
- Routing Settings
Performance
The Zendesk Chat API enforces a rate limit of 200 requests per minute per endpoint. The connector automatically manages rate limits by respecting the Retry-After header when it receives a 429 response.
Troubleshooting
Invalid, expired or incorrectly scoped access token
The connector stops the sync and reports a configuration error when Zendesk Chat returns a 401 Unauthorized response. To resolve this error:
- Airbyte Cloud: Edit the source and click Authenticate your Zendesk Chat account to re-authorise the connection.
- Airbyte Open Source: Generate a new access token with the
readandchatscopes. Then update the Access Token field.
Requests returning 404
The connector ignores any 404 Not Found response from Zendesk Chat and continues the sync. It doesn’t emit records from that request. This response usually occurs when a record has been deleted. However, this behaviour applies to every stream and request. A 404 response on a list request therefore drops that results page.
Data type map
| Integration Type | Airbyte Type |
|---|---|
string | string |
number | number |
array | array |
object | object |
IP allow list
If you use Airbyte Cloud and restrict access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.
Changelog
Expand to review
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 1.3.34 | 2026-11-10 | 91778 | Update dependencies |
| 1.3.33 | 2026-11-03 | 90807 | Update dependencies |
| 1.3.32 | 2026-10-27 | 90082 | Update dependencies |
| 1.3.31 | 2026-10-20 | 89485 | Update dependencies |
| 1.3.30 | 2026-10-13 | 88886 | Update dependencies |
| 1.3.29 | 2026-10-06 | 88112 | Update dependencies |
| 1.3.28 | 2026-09-29 | 87433 | Update dependencies |
| 1.3.27 | 2026-09-22 | 86888 | Update dependencies |
| 1.3.26 | 2026-09-16 | 83336 | Show a clearer error when Zendesk Chat rejects the access token |
| 1.3.25 | 2026-09-15 | 86312 | Update dependencies |
| 1.3.24 | 2026-09-08 | 85714 | Update dependencies |
| 1.3.23 | 2026-08-18 | 84835 | Update dependencies |
| 1.3.22 | 2026-08-11 | 84170 | Update dependencies |
| 1.3.21 | 2026-07-28 | 83194 | Update to CDK 7.23.8 (fixes AirbyteCustomCodeNotPermittedError for bundled custom components) and remove the temporary Cloud version override |
| 1.3.20 | 2026-07-28 | 1082 | Roll Cloud back to 1.3.18 — 1.3.19 is built on SDM 7.23.7, which breaks bundled custom components |
| 1.3.19 | 2026-07-28 | 83161 | Update dependencies |
| 1.3.18 | 2026-07-21 | 82671 | Update dependencies |
| 1.3.17 | 2026-07-14 | 82082 | Update dependencies |
| 1.3.16 | 2026-06-30 | 81327 | Update dependencies |
| 1.3.15 | 2026-06-23 | 80709 | Update dependencies |
| 1.3.14 | 2026-06-16 | 80102 | Update dependencies |
| 1.3.13 | 2026-06-09 | 79569 | Update dependencies |
| 1.3.12 | 2026-06-02 | 79069 | Update dependencies |
| 1.3.11 | 2026-04-28 | 77490 | Update dependencies |
| 1.3.10 | 2026-04-21 | 76846 | Bump SDM base image to stable 7.17.2 |
| 1.3.9 | 2026-03-31 | 75942 | Bump SDM base image for memory monitor (CDK PR #962) |
| 1.3.8 | 2026-03-31 | 75858 | Update dependencies |
| 1.3.7 | 2026-03-17 | 74324 | Migrate to scopes object array format |
| 1.3.6 | 2026-03-17 | 75116 | Update dependencies |
| 1.3.5 | 2026-03-10 | 74671 | Update dependencies |
| 1.3.4 | 2026-03-03 | 74156 | Update dependencies |
| 1.3.3 | 2026-02-17 | 73534 | Update dependencies |
| 1.3.2 | 2026-02-10 | 73151 | Update dependencies |
| 1.3.1 | 2026-02-03 | 72611 | Update dependencies |
| 1.3.0 | 2026-01-28 | 71829 | Add OAuth2.0 support for Airbyte Cloud |
| 1.2.31 | 2026-01-20 | 72091 | Update dependencies |
| 1.2.30 | 2026-01-14 | 71701 | Update dependencies |
| 1.2.29 | 2025-12-18 | 70681 | Update dependencies |
| 1.2.28 | 2025-11-25 | 70128 | Update dependencies |
| 1.2.27 | 2025-11-18 | 69513 | Update dependencies |
| 1.2.26 | 2025-10-29 | 68958 | Update dependencies |
| 1.2.25 | 2025-10-27 | 68629 | Fix Pagination for chats and agent_timeline streams |
| 1.2.24 | 2025-10-22 | 68591 | Add suggestedStreams |
| 1.2.23 | 2025-10-22 | 67607 | Handle 404 errors for deleted records in all streams |
| 1.2.22 | 2025-10-21 | 68440 | Update dependencies |
| 1.2.21 | 2025-10-14 | 68020 | Update dependencies |
| 1.2.20 | 2025-10-07 | 67238 | Update dependencies |
| 1.2.19 | 2025-09-30 | 66845 | Update dependencies |
| 1.2.18 | 2025-09-24 | 66459 | Update dependencies |
| 1.2.17 | 2025-09-09 | 65491 | Update dependencies |
| 1.2.16 | 2025-08-10 | 64864 | Update dependencies |
| 1.2.15 | 2025-08-02 | 64305 | Update dependencies |
| 1.2.14 | 2025-07-26 | 64053 | Update dependencies |
| 1.2.13 | 2025-07-20 | 63650 | Update dependencies |
| 1.2.12 | 2025-07-12 | 63177 | Update dependencies |
| 1.2.11 | 2025-07-05 | 62677 | Update dependencies |
| 1.2.10 | 2025-06-28 | 62247 | Update dependencies |
| 1.2.9 | 2025-06-21 | 61751 | Update dependencies |
| 1.2.8 | 2025-06-15 | 61248 | Update dependencies |
| 1.2.7 | 2025-05-24 | 60782 | Update dependencies |
| 1.2.6 | 2025-05-10 | 59993 | Update dependencies |
| 1.2.5 | 2025-05-04 | 58949 | Update dependencies |
| 1.2.4 | 2025-04-19 | 58028 | Update dependencies |
| 1.2.3 | 2025-04-05 | 57404 | Update dependencies |
| 1.2.2 | 2025-03-29 | 56850 | Update dependencies |
| 1.2.1 | 2025-03-22 | 56345 | Update dependencies |
| 1.2.0 | 2025-03-10 | 47319 | Migrate to Manifest-only |
| 1.1.1 | 2025-03-09 | 54110 | Update dependencies |
| 1.1.0 | 2025-03-03 | 54151 | Migrate to incrementalcursors |
| 1.0.4 | 2025-02-01 | 53081 | Update dependencies |
| 1.0.3 | 2025-01-25 | 51942 | Update dependencies |
| 1.0.2 | 2025-01-22 | 52065 | Pinned airbyte-cdk version to 0.72.2 |
| 1.0.1 | 2025-01-11 | 43728 | Starting 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.0 | 2024-11-04 | 44898 | Migrate to new base url |
| 0.3.1 | 2024-06-06 | 39260 | [autopull] Upgrade base image to v1.2.2 |
| 0.3.0 | 2024-03-07 | 35867 | Migrated to YamlDeclarativeSource (Low-code) Airbyte CDK |
| 0.2.2 | 2024-02-12 | 35185 | Manage dependencies with Poetry. |
| 0.2.1 | 2023-10-20 | 31643 | Upgrade base image to airbyte/python-connector-base:1.1.0 |
| 0.2.0 | 2023-10-11 | 30526 | Use the python connector base image, remove dockerfile and implement build_customization.py |
| 0.1.14 | 2023-02-10 | 24190 | Fix remove too high min/max from account stream |
| 0.1.13 | 2023-02-10 | 22819 | Specified date formatting in specification |
| 0.1.12 | 2023-01-27 | 22026 | Set AvailabilityStrategy for streams explicitly to None |
| 0.1.11 | 2022-10-18 | 17745 | Add Engagements Stream and fix infity looping |
| 0.1.10 | 2022-09-28 | 17326 | Migrate to per-stream states. |
| 0.1.9 | 2022-08-23 | 15879 | Corrected specification and stream schemas to support backward capability |
| 0.1.8 | 2022-06-28 | 13387 | Add state checkpoint to allow long runs |
| 0.1.7 | 2022-05-25 | 12883 | Pass timeout in request to prevent a stuck connection |
| 0.1.6 | 2021-12-15 | 7313 | Add support of OAuth 2.0 authentication. Fixed the issue with created_at can now be null for bans stream |
| 0.1.5 | 2021-12-06 | 8425 | Update title, description fields in spec |
| 0.1.4 | 2021-11-22 | 8166 | Make Chats stream incremental + add tests for all streams |
| 0.1.3 | 2021-10-21 | 7210 | Chats stream is only getting data from first page |
| 0.1.2 | 2021-08-17 | 5476 | Correct field unread to boolean type |
| 0.1.1 | 2021-06-09 | 3973 | Add AIRBYTE_ENTRYPOINT for Kubernetes support |
| 0.1.0 | 2021-05-03 | 3088 | Initial release |