Zendesk Support
This page contains the setup guide and reference information for the Zendesk Support source connector.
Prerequisites
- A Zendesk account with an Administrator role.
Setup guide
The Zendesk Support source connector supports two authentication methods:
- OAuth 2.0
- API token
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.
For Airbyte Open Source:
We recommend using an API token to authenticate your Zendesk Support account. Please follow the steps below to generate this key.
If you prefer to authenticate with OAuth for Airbyte Open Source, you can follow the steps laid out in this Zendesk article to obtain your client ID, client secret and access token. Please ensure you set the scope to read
when generating the access token.
Generate an API token
-
Log in to your Zendesk account.
-
Click the Zendesk Products icon (four squares) in the top-right corner, then select Admin Center.
-
In the left navbar, click Apps and Integrations, then select APIs > Zendesk API.
-
In the Settings tab, toggle the option to enable token access.
-
Click the Add API token button. You may optionally provide a token description.
cautionBe sure to copy the token and save it in a secure location. You will not be able to access the token's value after you close the page.
-
Click Save.
Set up the Zendesk Support source connector
- Log in to your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click + New source.
- Find and select Zendesk Support from the list of available sources.
- For Source name, enter a name to help you identify this source.
- You can use OAuth or an API token to authenticate your Zendesk Support account.
- 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 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.
- 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/
, thenMY_SUBDOMAIN
is your subdomain. - (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. - Click Set up source and wait for the tests to complete.
Supported sync modes
The Zendesk Support source connector supports the following sync modes:
- Full Refresh | Overwrite
- Full Refresh | Append
- Incremental Sync | Append
- Incremental Sync | Deduped History
There are two types of incremental sync:
- Incremental (standard server-side, where API returns only the data updated or generated since the last sync).
- Client-Side Incremental (API returns all available data and connector filters out only new records).
Supported streams
The Zendesk Support source connector supports the following streams:
- Account Attributes
- Articles (Incremental)
- Article Votes (Incremental)
- Article Comments (Incremental)
- Article Comment Votes (Incremental)
- Attribute Definitions
- Audit Logs(Incremental) (Only available for enterprise accounts)
- Brands
- Custom Roles (Incremental)
- Groups (Incremental)
- Group Memberships (Incremental)
- Macros (Incremental)
- Organizations (Incremental)
- Organization Fields (Incremental)
- Organization Memberships (Incremental)
- Posts (Incremental)
- Post Comments (Incremental)
- Post Comment Votes (Incremental)
- Post Votes (Incremental)
- Satisfaction Ratings (Incremental)
- Schedules (Incremental)
- SLA Policies (Incremental)
- Tags
- Tickets (Incremental)
- Ticket Audits (Client-Side Incremental)
- Ticket Comments (Incremental)
- Ticket Fields (Incremental)
- Ticket Forms (Incremental)
- Ticket Metrics (Incremental)
- Ticket Metric Events (Incremental)
- Topics (Incremental)
- Ticket Skips (Incremental)
- Users (Incremental)
- UserFields
Deleted Records Support
The Zendesk Support connector fetches deleted records in the following streams:
Stream | Deletion indicator field |
---|---|
Brands | is_deleted |
Groups | deleted |
Organizations | deleted_at |
Ticket Metric Events | deleted |
Tickets | status ==deleted |