Zendesk Talk
Prerequisites
- Zendesk API Token or Zendesk OAuth Client
- Zendesk Email (For API Token authentication)
- Zendesk Subdomain
Setup guide
Step 1: Set up Zendesk
Generate a API access token as described in Zendesk docs
We recommend creating a restricted, read-only key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access.
Another option is to use OAuth2.0 for authentication. See Zendesk docs for details.
Step 2: Set up the Zendesk Talk connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click +new source.
- On the Set up the source page, enter the name for the Zendesk Talk connector and select Zendesk Talk from the Source type dropdown.
- Fill in the rest of the fields:
- Subdomain
- Authentication (API Token / OAuth2.0)
- Start Date
- Click Set up source
Supported sync modes
The Zendesk Talk source connector supports the following sync modes:
- Full Refresh
- Incremental Sync
Supported Streams
This Source is capable of syncing the following core Streams:
- Account Overview
- Addresses
- Agents Activity
- Agents Overview
- Calls (Incremental sync)
- Call Legs (Incremental sync)
- Current Queue Activity
- Greeting Categories
- Greetings
- IVRs
- IVR Menus
- IVR Routes
- Phone Numbers
Performance considerations
The connector is restricted by normal Zendesk requests limitation.
The Zendesk connector should not run into Zendesk API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
Data type map
| Integration Type | Airbyte Type | Notes |
|---|---|---|
string | string | |
number | number | |
array | array | |
object | object |
Reference
Config fields reference
Field
Type
Property name
string
subdomain
string
start_date
object
credentials
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.2.0 | 2024-03-25 | 36459 | Unpin CDK version, add record counts in state messages |
| 0.1.13 | 2024-03-04 | 35783 | Change order of authentication methods in spec |
| 0.1.12 | 2024-02-12 | 35156 | Manage dependencies with Poetry. |
| 0.1.11 | 2024-01-12 | 34204 | Prepare for airbyte-lib |
| 0.1.10 | 2023-12-04 | 33030 | Base image migration: remove Dockerfile and use python-connector-base image |
| 0.1.9 | 2023-08-03 | 29031 | Reverted advancedAuth spec changes |
| 0.1.8 | 2023-08-01 | 28910 | Updated advancedAuth broken references |
| 0.1.7 | 2023-02-10 | 22815 | Specified date formatting in specification |
| 0.1.6 | 2023-01-27 | 22028 | Set AvailabilityStrategy for streams explicitly to None |
| 0.1.5 | 2022-09-29 | 17362 | always use the latest CDK version |
| 0.1.4 | 2022-08-19 | 15764 | Support OAuth2.0 |
| 0.1.3 | 2021-11-11 | 7173 | Fix pagination and migrate to CDK |