Skip to main content

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:

Supported Streams

Performance considerations

The connector is restricted by Zendesk's requests limitation.

Data type map

Integration TypeAirbyte Type
stringstring
numbernumber
arrayarray
objectobject

Changelog

VersionDatePull RequestSubject
0.2.02023-10-1130526Use the python connector base image, remove dockerfile and implement build_customization.py
0.1.142023-02-1024190Fix remove too high min/max from account stream
0.1.132023-02-1022819Specified date formatting in specification
0.1.122023-01-2722026Set AvailabilityStrategy for streams explicitly to None
0.1.112022-10-1817745Add Engagements Stream and fix infity looping
0.1.102022-09-2817326Migrate to per-stream states.
0.1.92022-08-2315879Corrected specification and stream schemas to support backward capability
0.1.82022-06-2813387Add state checkpoint to allow long runs
0.1.72022-05-2512883Pass timeout in request to prevent a stuck connection
0.1.62021-12-157313Add support of OAuth 2.0 authentication. Fixed the issue with created_at can now be null for bans stream
0.1.52021-12-068425Update title, description fields in spec
0.1.42021-11-228166Make Chats stream incremental + add tests for all streams
0.1.32021-10-217210Chats stream is only getting data from first page
0.1.22021-08-175476Correct field unread to boolean type
0.1.12021-06-093973Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.1.02021-05-033088Initial release