Skip to content

docs(source-zendesk-support): improve OAuth authentication documentation #72390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
devin-ai-integration wants to merge 2 commits into
base: master
Choose a base branch
from
+23 −10
Draft

docs(source-zendesk-support): improve OAuth authentication documentation #72390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afe82eb
docs(source-zendesk-support): improve OAuth authentication documentation
devin-ai-integration[bot] Jan 27, 2026
4c49c19
fix: correct link fragment to match actual heading
devin-ai-integration[bot] Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions docs/integrations/sources/zendesk-support-migrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,24 @@ This version adds OAuth2.0 with refresh token support. Users who authenticate vi

### What changed

The OAuth authentication flow has been updated to support Zendesk's new grant-type tokens with rotating refresh tokens. The legacy OAuth2.0 option has been renamed to "OAuth2.0 (Legacy)" and a new "OAuth2.0 with Refresh Token" option has been added.
Zendesk announced support for OAuth refresh token grant type starting April 30, 2025, with a requirement for all customers to adopt this flow by April 30, 2026. The connector has been updated to support this new authentication flow.

The OAuth authentication flow now uses rotating refresh tokens. When the connector refreshes an access token, Zendesk returns a new refresh token and invalidates the previous one. This provides enhanced security but requires the connector to properly handle token rotation.

The legacy OAuth2.0 option has been renamed to "OAuth2.0 (Legacy)" and a new "OAuth2.0 with Refresh Token" option has been added.

### Who is affected

This change affects users who authenticate via OAuth. Users who authenticate with API tokens are not affected.

### Migration steps

1. Go to your Zendesk Support connection settings in Airbyte
2. If you are using OAuth authentication, you will need to re-authenticate
3. Select "OAuth2.0 with Refresh Token" as the authentication method
4. Complete the OAuth flow to authorize the connector
1. Go to your Zendesk Support connection settings in Airbyte.
2. If you are using OAuth authentication, you will need to re-authenticate.
3. Select "OAuth2.0 with Refresh Token" as the authentication method.
4. Complete the OAuth flow to authorize the connector.

For more information about Zendesk's OAuth changes, see [Zendesk's OAuth refresh token announcement](https://support.zendesk.com/hc/en-us/articles/9182123625370).

### Connector upgrade guide

Expand Down
13 changes: 8 additions & 5 deletions docs/integrations/sources/zendesk-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,19 @@ This page contains the setup guide and reference information for the [Zendesk Su

## Set up Zendesk Support

The Zendesk Support source connector supports two authentication methods:
The Zendesk Support source connector supports the following authentication methods:

- OAuth 2.0
- API token
- OAuth 2.0 with Refresh Token (recommended for Airbyte Cloud)
- API Token (recommended for Airbyte Open Source)
- OAuth 2.0 (Legacy) for existing connections

Zendesk is transitioning to OAuth with rotating refresh tokens. All customers must adopt this new OAuth flow by April 30, 2026. For more information, see [Zendesk's OAuth refresh token announcement](https://support.zendesk.com/hc/en-us/articles/9182123625370).

<!-- env:cloud -->

**For Airbyte Cloud:**

We highly recommend using OAuth to authenticate your Zendesk Support account, as it simplifies the setup process and allows you to authenticate [directly from the Airbyte UI](#set-up-the-zendesk-support-source-connector).
We highly recommend using OAuth 2.0 with Refresh Token to authenticate your Zendesk Support account, as it simplifies the setup process, allows you to authenticate [directly from the Airbyte UI](#set-up-the-zendesk-support-connector-in-airbyte), and automatically handles token refresh with rotating refresh tokens.

<!-- /env:cloud -->

Expand Down Expand Up @@ -76,7 +79,7 @@ If you prefer to authenticate with OAuth for **Airbyte Open Source**, you can fo
5. You can use OAuth or an API token to authenticate your Zendesk Support account.
<!-- env:cloud -->

- **For Airbyte Cloud**: To authenticate using OAuth, select **OAuth 2.0** from the Authentication dropdown, then click **Authenticate your Zendesk Support account** to sign in with Zendesk Support and authorize your account.
- **For Airbyte Cloud**: To authenticate using OAuth, select **OAuth 2.0 with Refresh Token** from the Authentication dropdown, then click **Authenticate your Zendesk Support account** to sign in with Zendesk Support and authorize your account. This method uses rotating refresh tokens to automatically maintain your connection.
<!-- /env:cloud -->
<!-- env:oss -->
- **For Airbyte Open Source**: To authenticate using an API key, select **API Token** from the Authentication dropdown and enter the API token you generated, as well as the email address associated with your Zendesk Support account.
Expand Down
Loading