Skip to main content

Zendesk Support

This page guides you through setting up the Zendesk Support source connector.

Prerequisites

  • Locate your Zendesk subdomain found in your account URL. For example, if your account URL is https://{MY_SUBDOMAIN}.zendesk.com/, then MY_SUBDOMAIN is your subdomain.
  • (For Airbyte OSS) Find the email address associated with your Zendesk account. Also, generate an API token for the account.

Set up the Zendesk Support source connector

  1. Log into your Airbyte Cloud or Airbyte OSS account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Zendesk Support from the Source type dropdown.
  4. Enter a name for your source.
  5. For Subdomain, enter your Zendesk 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. If this field is blank, Airbyte will replicate all data.
  7. You can use OAuth or an API key to authenticate your Zendesk Support account. We recommend using OAuth for Airbyte Cloud and an API key for Airbyte OSS.
    • To authenticate using OAuth for Airbyte Cloud, click Authenticate your Zendesk Support account to sign in with Zendesk Support and authorize your account.
    • To authenticate using an API key for Airbyte OSS, select API key from the Authentication dropdown and enter your API key. Enter the Email associated with your Zendesk Support account.
  8. Click Set up source.

Supported sync modes

The Zendesk Support source connector supports the following sync modes:

  • Full Refresh - overwrite
  • Full Refresh - append
  • Incremental - append

Supported streams

The Zendesk Support source connector supports the following streams:

Performance considerations

The connector is restricted by normal Zendesk requests limitation.

The Zendesk connector ideally should not run into Zendesk API limitations under normal usage. Create an issue if you see any rate limit issues that are not automatically retried successfully.

Changelog

VersionDatePull RequestSubject
0.2.122022-06-3014304Fixed Pagination for Group Membership stream
0.2.112022-06-2414112Fixed "Retry-After" non integer value
0.2.102022-06-1413757Fixed the bug with TicketMetrics stream, HTTP Error 429, caused by lots of API requests
0.2.92022-05-2713261Bugfix for the unhandled ChunkedEncodingError and ConnectionError
0.2.82022-05-2013055Fixed minor issue for stream ticket_audits schema
0.2.72022-04-2712335Adding fixtures to mock time.sleep for connectors that explicitly sleep
0.2.62022-04-1912122Fixed the bug when only 100,000 Users are synced 11895 and fixed bug when start_date is not used on user stream 12059.
0.2.52022-04-0511727Fixed the bug when state was not parsed correctly
0.2.42022-04-0411688Small documentation corrections
0.2.32022-03-2311349Fixed the bug when Tickets stream didn't return deleted records
0.2.22022-03-1711237Fixed the bug when TicketComments stream didn't return all records
0.2.12022-03-1511162Added support of OAuth2.0 authentication method
0.2.02022-03-019456Update source to use future requests
0.1.122022-01-259785Add additional log messages
0.1.112021-12-218987Update connector fields title/description
0.1.92021-12-168616Adds Brands, CustomRoles and Schedules streams
0.1.82021-11-238050Adds TicketMetricEvents stream
0.1.72021-11-238058Added support of AccessToken authentication
0.1.62021-11-188050Fix wrong types for schemas, add TypeTransformer
0.1.52021-10-267679Add ticket_id and ticket_comments
0.1.42021-10-267377Fix initially_assigned_at type in ticket metrics
0.1.32021-10-177097Corrected the connector's specification
0.1.22021-10-166513Fixed TicketComments stream
0.1.12021-09-025787Fixed incremental logic for the ticket_comments stream
0.1.02021-07-214861Created CDK native zendesk connector