You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/sources/zendesk-support.md
+28-12Lines changed: 28 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,10 +15,15 @@ This page contains the setup guide and reference information for the [Zendesk Su
15
15
16
16
### Set up Zendesk Support
17
17
18
-
The Zendesk Support source connector supports two authentication methods:
18
+
The Zendesk Support source connector supports three authentication methods:
19
19
20
-
- OAuth 2.0
21
-
- API token
20
+
- OAuth 2.0 with refresh token (recommended for Airbyte Cloud)
21
+
- API token (recommended for Airbyte Open Source)
22
+
- OAuth 2.0 Legacy (for existing OAuth connections that haven't migrated to the refresh token flow)
23
+
24
+
:::note
25
+
Zendesk is [enforcing OAuth token expiration](https://support.zendesk.com/hc/en-us/articles/9182123625370) and requiring the refresh token flow. If you use the legacy OAuth method, plan to migrate to OAuth 2.0 with refresh token before Zendesk's deadline.
26
+
:::
22
27
23
28
<!-- env:cloud -->
24
29
@@ -84,7 +89,9 @@ If you prefer to authenticate with OAuth for **Airbyte Open Source**, you can fo
84
89
85
90
6. For **Subdomain**, enter your Zendesk subdomain. This is the subdomain found in your account URL. For example, if your account URL is `https://MY_SUBDOMAIN.zendesk.com/`, then `MY_SUBDOMAIN` is your subdomain.
86
91
7. (Optional) For **Start Date**, use the provided datepicker or enter a UTC date and time programmatically in the format `YYYY-MM-DDTHH:mm:ssZ`. The data added on and after this date will be replicated. If this field is left blank, Airbyte will replicate the data for the last two years by default.
87
-
8. Click **Set up source** and wait for the tests to complete.
92
+
8. (Optional) For **Number of concurrent workers**, enter the number of parallel threads to use for the sync. The default is 3. Increase this value if your Zendesk plan supports higher rate limits. See [Rate limiting](#rate-limiting) for details.
93
+
9. (Optional) For **Page Size (ticket_comments)**, enter the number of records per page for the `ticket_comments` stream. The default is 100 and the maximum is 1000. Lower values may help prevent timeouts on large Zendesk instances.
94
+
10. Click **Set up source** and wait for the tests to complete.
88
95
<!-- /env:oss -->
89
96
90
97
<HideInUI>
@@ -116,7 +123,7 @@ The Zendesk Support source connector supports the following streams:
-[Audit Logs](https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/#list-audit-logs)\(Incremental\)(Only available for enterprise accounts)
@@ -174,13 +181,22 @@ Expand to see details about Zendesk Support connector limitations and troublesho
174
181
175
182
#### Rate limiting
176
183
177
-
The connector is restricted by normal Zendesk [requests limitation](https://developer.zendesk.com/api-reference/introduction/rate-limits/).
184
+
Zendesk applies [rate limits](https://developer.zendesk.com/api-reference/introduction/rate-limits/) based on your plan tier:
185
+
186
+
| Plan | Requests per minute |
187
+
| :--- | :--- |
188
+
| Team | 200 |
189
+
| Growth / Professional | 400 |
190
+
| Enterprise | 700 |
191
+
| Enterprise Plus / High Volume API add-on | 2500 |
192
+
193
+
The connector's **Number of concurrent workers** setting (default: 3) controls how many streams sync in parallel. If your plan supports higher rate limits, increase this value for faster syncs. The maximum is 40.
178
194
179
-
Zendesk's [incremental export endpoints](https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#rate-limits) have a stricter rate limit of 10 requests per minute. This applies to the `tickets`, `ticket_comments`, `ticket_metric_events`, `users`, and `organizations` streams that use incremental exports. The connector includes a built-in API budget that automatically throttles requests to stay within this limit.
195
+
Zendesk's [incremental export endpoints](https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#rate-limits) have a stricter rate limit of 10 requests per minute, regardless of plan tier. This applies to the `tickets`, `ticket_comments`, `ticket_metric_events`, `users`, and `organizations` streams that use incremental exports. The connector includes a built-in API budget that automatically throttles requests to stay within this limit.
180
196
181
197
If the connector receives a 429 (Too Many Requests) response, it respects the `Retry-After` header and waits before retrying. The `ticket_comments` stream also retries on 504 (Gateway Timeout) errors with exponential backoff, which can occur on large Zendesk instances.
182
198
183
-
The Zendesk connector ideally should not run into Zendesk API limitations under normal usage. [Create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
199
+
The connector should not run into Zendesk API limitations under normal usage. [Create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
184
200
185
201
### Troubleshooting
186
202
@@ -195,7 +211,7 @@ The Zendesk connector ideally should not run into Zendesk API limitations under
| 5.1.7-rc.1 | 2026-03-09|[11103](https://github.com/airbytehq/oncall/issues/11103)| Pin CDK to 7.8.1.post54 for regression testing of StateDelegatingStream and DeclarativeStream |
214
+
| 5.1.7-rc.1 | 2026-03-10|[74398](https://github.com/airbytehq/airbyte/pull/74398)| Pin CDK to 7.8.1.post54 for regression testing of StateDelegatingStream and DeclarativeStream |
199
215
| 5.1.6 | 2026-03-09 |[73686](https://github.com/airbytehq/airbyte/pull/73686)| Add 504 exponential backoff error handling to `ticket_comments` stream and API budget (10 req/min) for all incremental export streams |
| 5.0.0 | 2026-01-21|[70990](https://github.com/airbytehq/airbyte/pull/70990)| Add OAuth2.0 with refresh token support. Users using OAuth must re-authenticate to use the new flow with rotating refresh tokens. |
225
+
| 5.0.0 | 2026-01-22|[70990](https://github.com/airbytehq/airbyte/pull/70990)| Add OAuth2.0 with refresh token support. Users using OAuth must re-authenticate to use the new flow with rotating refresh tokens. |
0 commit comments