zendesk-support.md

Zendesk Support

Sync overview

The Zendesk Support source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

This source can sync data for the Zendesk Support API. This Source Connector is based on a Airbyte CDK. Incremental sync are implemented on API side by its filters

Output schema

This Source is capable of syncing the following core Streams:

• Tickets

• Groups

• Users

• Organizations

• Ticket Audits

• Ticket Comments

• Ticket Fields

• Ticket Forms

• Ticket Metrics

• Ticket Metric Events

• Group Memberships

• Macros

• Satisfaction Ratings

• Tags

• SLA Policies

  Not implemented schema

  These Zendesk endpoints are available too. But syncing with them will be implemented in the future.

  Tickets

• Ticket Attachments

• Ticket Requests

• Ticket Activities

• Ticket Skips

  Help Center

• Articles

• Article Attachments

• Article Comments

• Categories

• Management Permission Groups

• Translations

• Sections

• Topics

• Themes

• Posts

• Themes

• Post Comments

Data type mapping

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

Features

Feature	Supported?(Yes/No)	Notes
Full Refresh Sync	Yes
Incremental - Append Sync	Yes
Incremental - Debuped + History Sync	Yes	Enabled according to type of destination
Namespaces	No

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 Subdomain
• Auth Method
  • API Token
    • Zendesk API Token
    • Zendesk Email
  • oAuth2 (not implemented)

Setup guide

Generate a API access token using the Zendesk support

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

Version	Date	Pull Request	Subject
0.1.11	2021-12-21	8987	Update connector fields title/description
0.1.9	2021-12-16	8616	Adds Brands, CustomRoles and Schedules
0.1.8	2021-11-23	8050	Adds TicketMetricEvents
0.1.7	2021-11-23	8058	support AccessToken auth
0.1.6	2021-11-18	8050	Fix wrong types for schemas, add Transformer
0.1.5	2021-10-26	7679	Add ticket_id and ticket_comments
0.1.4	2021-10-26	7377	fix initially_assigned_at type in ticket metrics
0.1.3	2021-10-17	7097	correction of spec file
0.1.2	2021-10-16	6513	fixed comments stream
0.1.1	2021-09-02	5787	fixed incremental logic for the ticket_comments stream
0.1.0	2021-07-21	4861	created CDK native zendesk connector