Skip to main content

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:

Data type mapping

Integration TypeAirbyte TypeNotes
stringstring
numbernumber
arrayarray
objectobject

Features

FeatureSupported?(Yes/No)Notes
Full Refresh SyncYes
Incremental SyncYes

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.

Reference

Config fields reference

Field
Type
Property name
string
subdomain
string
start_date
object
credentials

Changelog

VersionDatePull RequestSubject
0.2.02023-08-2229310Migrate Python CDK to Low Code
0.1.22023-08-157976Fix schemas and tests
0.1.12021-11-157976Add oauth2.0 support
0.1.02021-07-084359Initial Release