Skip to content

Commit fe9d01b

Browse files
devin-ai-integration[bot]bot_apk
andauthored
docs(source-zendesk-support): improve documentation accuracy and completeness (#74719)
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: bot_apk <apk@cognition.ai>
1 parent 2dd3b07 commit fe9d01b

1 file changed

Lines changed: 28 additions & 12 deletions

File tree

docs/integrations/sources/zendesk-support.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,15 @@ This page contains the setup guide and reference information for the [Zendesk Su
1515

1616
### Set up Zendesk Support
1717

18-
The Zendesk Support source connector supports two authentication methods:
18+
The Zendesk Support source connector supports three authentication methods:
1919

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+
:::
2227

2328
<!-- env:cloud -->
2429

@@ -84,7 +89,9 @@ If you prefer to authenticate with OAuth for **Airbyte Open Source**, you can fo
8489

8590
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.
8691
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.
8895
<!-- /env:oss -->
8996

9097
<HideInUI>
@@ -116,7 +123,7 @@ The Zendesk Support source connector supports the following streams:
116123
- [Article Comment Votes](https://developer.zendesk.com/api-reference/help_center/help-center-api/votes/#list-votes) \(Incremental\)
117124
- [Article Attachments](https://developer.zendesk.com/api-reference/help_center/help-center-api/article_attachments/#list-article-attachments) \(Incremental\) \(Supports file transfer\)
118125
- [Attribute Definitions](https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/#list-routing-attribute-definitions)
119-
- [Audit Logs](https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/#list-audit-logs)\(Incremental\) (Only available for enterprise accounts)
126+
- [Audit Logs](https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/#list-audit-logs) \(Incremental\) \(Enterprise only\)
120127
- [Automations](https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/#list-automations)
121128
- [Brands](https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#list-brands)
122129
- [Custom Roles](https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#list-custom-roles) \(Incremental\)
@@ -146,8 +153,8 @@ The Zendesk Support source connector supports the following streams:
146153
- [Triggers](https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/#list-ticket-triggers) \(Incremental\)
147154
- [Ticket Skips](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/) \(Incremental\)
148155
- [Users](https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#incremental-user-export) \(Incremental\)
149-
- [UserIdentities](https://developer.zendesk.com/api-reference/ticketing/users/user_identities/) \(Incremental\)
150-
- [UserFields](https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#list-user-fields)
156+
- [User Identities](https://developer.zendesk.com/api-reference/ticketing/users/user_identities/) \(Incremental\)
157+
- [User Fields](https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#list-user-fields)
151158
- [Categories](https://developer.zendesk.com/api-reference/help_center/help-center-api/categories/#list-categories)
152159
- [Sections](https://developer.zendesk.com/api-reference/help_center/help-center-api/sections/#list-sections)
153160

@@ -174,13 +181,22 @@ Expand to see details about Zendesk Support connector limitations and troublesho
174181

175182
#### Rate limiting
176183

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.
178194

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.
180196

181197
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.
182198

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.
184200

185201
### Troubleshooting
186202

@@ -195,7 +211,7 @@ The Zendesk connector ideally should not run into Zendesk API limitations under
195211

196212
| Version | Date | Pull Request | Subject |
197213
|:------------|:-----------|:---------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
198-
| 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 |
199215
| 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 |
200216
| 5.1.5 | 2026-02-24 | [45667](https://github.com/airbytehq/airbyte/issues/45667) | Add missing SLA fields (`sla`, `group_sla`, `status`, `deleted`) to `ticket_metric_events` schema |
201217
| 5.1.4 | 2026-02-24 | [73911](https://github.com/airbytehq/airbyte/pull/73911) | Update dependencies |
@@ -206,7 +222,7 @@ The Zendesk connector ideally should not run into Zendesk API limitations under
206222
| 5.0.3 | 2026-01-28 | [72423](https://github.com/airbytehq/airbyte/pull/72423) | Update breaking change deadline from Jan 31 to Jan 30 |
207223
| 5.0.2 | 2026-01-27 | [72380](https://github.com/airbytehq/airbyte/pull/72380) | Fix OAuth race condition with concurrent token refresh |
208224
| 5.0.1 | 2026-01-22 | [71714](https://github.com/airbytehq/airbyte/pull/71714) | Update dependencies |
209-
| 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. |
210226
| 4.10.18 | 2025-12-18 | [70717](https://github.com/airbytehq/airbyte/pull/70717) | Update dependencies |
211227
| 4.10.17 | 2025-12-02 | [70066](https://github.com/airbytehq/airbyte/pull/70066) | Update dependencies |
212228
| 4.10.16 | 2025-11-18 | [69538](https://github.com/airbytehq/airbyte/pull/69538) | Update dependencies |

0 commit comments

Comments
 (0)