Skip to main content

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:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. On the Set up the source page, enter the name for the Zendesk Talk connector and select Zendesk Talk from the Source type dropdown.
  4. Fill in the rest of the fields:
    • Subdomain
    • Authentication (API Token / OAuth2.0)
    • Start Date
  5. 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:

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 TypeAirbyte TypeNotes
stringstring
numbernumber
arrayarray
objectobject

Reference

Config fields reference

Field
Type
Property name
string
subdomain
string
start_date
object
credentials

Changelog

VersionDatePull RequestSubject
0.1.132024-03-0435783Change order of authentication methods in spec
0.1.122024-02-1235156Manage dependencies with Poetry.
0.1.112024-01-1234204Prepare for airbyte-lib
0.1.102023-12-0433030Base image migration: remove Dockerfile and use python-connector-base image
0.1.92023-08-0329031Reverted advancedAuth spec changes
0.1.82023-08-0128910Updated advancedAuth broken references
0.1.72023-02-1022815Specified date formatting in specification
0.1.62023-01-2722028Set AvailabilityStrategy for streams explicitly to None
0.1.52022-09-2917362always use the latest CDK version
0.1.42022-08-1915764Support OAuth2.0
0.1.32021-11-117173Fix pagination and migrate to CDK