Skip to content
This repository has been archived by the owner on Oct 28, 2022. It is now read-only.

Latest commit

 

History

History
95 lines (76 loc) · 7.29 KB

zendesk-support.md

File metadata and controls

95 lines (76 loc) · 7.29 KB
Raw

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:

Data type mapping

Integration Type Airbyte Type
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

  1. Click Authenticate your Zendesk account
  2. Enter a Start Date as the minimum date of your data replication.
  3. Enter your Subdomain. Learn how to find it in the Requirements section.
  4. Click on Setup Source.
  5. You're now ready to sync your data.

Requirements

  • Subdomain - this is your Zendesk subdomain that can be found in your account URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN is the value of your subdomain.
  • Authentication - Zendesk service provides two authentication methods. Choose between: OAuth2.0 or API token.
    • Authentication using OAuth2.0 (Only for Airbyte Cloud) - obtain access_token by authorising using your Zendesk Account credentials. Simply proceed by pressing "Authenticate your Zendesk Account" and complete the authentication.
    • Authentication using API Token:
      • API Token - the value of the API token generated. See the generating API Token for more information.
      • Email - the user email for your Zendesk account.

CHANGELOG

Version Date Pull Request Subject
0.2.6 2022-04-19 12122 Fixed 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.5 2022-04-05 11727 Fixed the bug when state was not parsed correctly
0.2.4 2022-04-04 11688 Small documentation corrections
0.2.3 2022-03-23 11349 Fixed the bug when Tickets stream didn't return deleted records
0.2.2 2022-03-17 11237 Fixed the bug when TicketComments stream didn't return all records
0.2.1 2022-03-15 11162 Added support of OAuth2.0 authentication method
0.2.0 2022-03-01 9456 Update source to use future requests
0.1.12 2022-01-25 9785 Add additional log messages
0.1.11 2021-12-21 8987 Update connector fields title/description
0.1.9 2021-12-16 8616 Adds Brands, CustomRoles and Schedules streams
0.1.8 2021-11-23 8050 Adds TicketMetricEvents stream
0.1.7 2021-11-23 8058 Added support of AccessToken authentication
0.1.6 2021-11-18 8050 Fix wrong types for schemas, add TypeTransformer
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 Corrected the connector's specification
0.1.2 2021-10-16 6513 Fixed TicketComments 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