Skip to main content

Zendesk Chat

Sync overview

The Zendesk Chat source supports Full Refresh and Incremental syncs.

This source can sync data for the Zendesk Chat API.

Output schema

This Source is capable of syncing the following core Streams:

Data type mapping

Integration TypeAirbyte TypeNotes
stringstring
numbernumber
arrayarray
objectobject

Features

FeatureSupported?(Yes/No)Notes
Full Refresh SyncYes
Incremental SyncYes
SSL connectionYes

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.

Getting started

Requirements

  • Zendesk Chat Access Token

Connect using OAuth 2.0 option:

  1. Select OAuth2.0 in Authorization Method
  2. Click on authenticate your Zendesk Chat account
  3. Proceed the authentication using your credentials for your Zendesk account.

Connect using Access Token option:

  1. Generate a Access Token as described in Zendesk Chat docs
  2. Use the generated access_token in Airbyte connection.

Setup guide

Generate a Access Token as described in Zendesk Chat 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.

Changelog

VersionDatePull RequestSubject
0.1.82022-06-2813387Add state checkpoint to allow long runs
0.1.72022-05-2512883Passing timeout in request to prevent a stuck connection
0.1.62021-12-157313Added support of OAuth 2.0 authentication. 8819 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