zendesk-sunshine.md

Zendesk Sunshine

Sync overview

The Zendesk Chat source supports Full Refresh and Incremental syncs.

This source can sync data for the Zendesk Sunshine API.

Output schema

This Source is capable of syncing the following core Streams:

• ObjectTypes

• ObjectRecords

• RelationshipTypes

• RelationshipRecords

• ObjectTypePolicies

• Jobs

  This stream is currently not available because it stores data temporary.

• Limits

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 Sync	Yes

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 Sunshine API Token

OR

• Zendesk Sunshine oauth2.0 application (client_id, client_secret, access_token)

Setup guide

Please follow this guide

Generate an API Token or oauth2.0 Access token as described in here

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.1	2021-11-15	7976	Add oauth2.0 support
0.1.0	2021-07-08	4359	Initial Release