Availability

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level

Certified

Latest Version

0.3.0

Zendesk Chat

This page contains the setup guide and reference information for the Zendesk Chat source connector.

Prerequisites

• A Zendesk Account with permission to access data from accounts you want to sync.

• (Airbyte Open Source) An Access Token (https://developer.zendesk.com/rest_api/docs/chat/auth). We recommend creating a restricted, read-only key specifically for Airbyte access to allow you to control which resources Airbyte should be able to access.

Setup guide

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Zendesk Chat from the Source type dropdown.
4. Enter the name for the Zendesk Chat connector.
5. If you access Zendesk Chat from a Zendesk subdomain, enter the Subdomain.
6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
7. Click Authenticate your Zendesk Chat account. Log in and authorize your Zendesk Chat account.
8. Click Set up source.

For Airbyte Open Source:

1. Navigate to the Airbyte Open Source dashboard.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Zendesk Chat from the Source type dropdown.
4. Enter the name for the Zendesk Chat connector.
5. If you access Zendesk Chat from a Zendesk subdomain, enter the Subdomain.
6. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
7. For Authorization Method, select Access Token from the dropdown and enter your Zendesk access token.
8. Click Set up source.

Supported sync modes

The Zendesk Chat source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Append + Deduped

Supported Streams

• Accounts
• Agents (Incremental)
• Agent Timelines (Incremental)
• Chats
• Shortcuts
• Triggers
• Bans (Incremental)
• Departments
• Goals
• Skills
• Roles
• Routing Settings

Performance considerations

The connector is restricted by Zendesk's requests limitation.

Data type map

Integration Type	Airbyte Type
string	string
number	number
array	array
object	object

Reference

Config fields reference

Field

Type

Property name

string

start_date

string

subdomain

object

credentials

Changelog

Version	Date	Pull Request	Subject
0.3.0	2024-03-07	35867	Migrated to YamlDeclarativeSource (Low-code) Airbyte CDK
0.2.2	2024-02-12	35185	Manage dependencies with Poetry.
0.2.1	2023-10-20	31643	Upgrade base image to airbyte/python-connector-base:1.1.0
0.2.0	2023-10-11	30526	Use the python connector base image, remove dockerfile and implement build_customization.py
0.1.14	2023-02-10	24190	Fix remove too high min/max from account stream
0.1.13	2023-02-10	22819	Specified date formatting in specification
0.1.12	2023-01-27	22026	Set AvailabilityStrategy for streams explicitly to None
0.1.11	2022-10-18	17745	Add Engagements Stream and fix infity looping
0.1.10	2022-09-28	17326	Migrate to per-stream states.
0.1.9	2022-08-23	15879	Corrected specification and stream schemas to support backward capability
0.1.8	2022-06-28	13387	Add state checkpoint to allow long runs
0.1.7	2022-05-25	12883	Pass timeout in request to prevent a stuck connection
0.1.6	2021-12-15	7313	Add support of OAuth 2.0 authentication. Fixed the issue with created_at can now be null for bans stream
0.1.5	2021-12-06	8425	Update title, description fields in spec
0.1.4	2021-11-22	8166	Make Chats stream incremental + add tests for all streams
0.1.3	2021-10-21	7210	Chats stream is only getting data from first page
0.1.2	2021-08-17	5476	Correct field unread to boolean type
0.1.1	2021-06-09	3973	Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.1.0	2021-05-03	3088	Initial release