ContextQMD
Back to Airbyte

Zendesk Sunshine

docs/integrations/sources/zendesk-sunshine.md

2.0.012.8 KB
Original Source

Zendesk Sunshine

This source syncs data from the Zendesk Sunshine API (also called the Legacy Custom Objects API), which provides access to custom objects and relationships in your Zendesk account.

Supported streams

This source syncs the following streams:

Only the ObjectRecords stream supports incremental sync. All other streams use full refresh.

Data type mapping

Integration TypeAirbyte TypeNotes
stringstring
numbernumber
arrayarray
objectobject

Performance considerations

The connector is restricted by Zendesk API rate limits. The connector automatically retries requests that receive a 429 Too Many Requests response using the Retry-After header. Under normal usage, you should not encounter rate limit issues. If you do, create an issue.

Prerequisites

  • A Zendesk account on a plan that supports Custom Objects (Suite Team or higher, or Support Enterprise). See Zendesk plan availability.
  • Custom Objects must be enabled in your Zendesk account. See Zendesk's guide to enabling Custom Objects.
  • Your Zendesk subdomain (the part before .zendesk.com in your Zendesk URL).
  • A start date for incremental syncs, in the format YYYY-MM-DDT00:00:00Z.
  • One of the following authentication methods:
    • OAuth2.0 (recommended for Airbyte Cloud): Client ID, Client Secret, and authorization through Airbyte's OAuth flow.
    • API Token (recommended for Airbyte Open Source): Your Zendesk email address and an API token.
    • OAuth2.0 (Legacy): A manually generated OAuth access token.

Setup guide

Authentication

This connector supports three authentication methods:

OAuth2.0 (recommended for Airbyte Cloud)

When you set up the connector in Airbyte Cloud, you'll be redirected to Zendesk to authorize the connection. This method uses refresh tokens to automatically maintain access without requiring you to manually regenerate tokens.

Zendesk uses rotating refresh tokens, meaning each time the connector refreshes its access token, it receives a new refresh token and the previous one is invalidated. The connector handles this automatically.

API Token (recommended for Airbyte Open Source)

To use API token authentication:

  1. In Zendesk, go to Admin Center > Apps and integrations > APIs > Zendesk API.
  2. Enable token access if it isn't already enabled.
  3. Click Add API token, give it a description, and click Save.
  4. Copy the token value. Zendesk only displays it once.
  5. In Airbyte, enter your Zendesk email address and the API token.

For more information, see Zendesk's API token documentation.

OAuth2.0 (Legacy)

This method uses a manually generated OAuth access token. It's provided for backward compatibility with existing connections. For new connections, use the OAuth2.0 method instead, which handles token refresh automatically.

To generate a legacy access token, follow Zendesk's OAuth documentation.

Changelog

<details> <summary>Expand to review</summary>
VersionDatePull RequestSubject
0.4.42026-03-1774393Migrate to scopes object array format
0.4.32026-03-1775115Update dependencies
0.4.22026-02-2473539Update dependencies
0.4.12026-02-1072608Update dependencies
0.4.02026-02-0371856Add OAuth2.0 with refresh token support; Upgrade CDK version to 7.8.1
0.3.412026-01-2072044Update dependencies
0.3.402026-01-1471709Update dependencies
0.3.392025-12-1870704Update dependencies
0.3.382025-11-2570071Update dependencies
0.3.372025-11-1869511Update dependencies
0.3.362025-10-2968965Update dependencies
0.3.352025-10-2168429Update dependencies
0.3.342025-10-1468014Update dependencies
0.3.332025-10-0767239Update dependencies
0.3.322025-09-3066852Update dependencies
0.3.312025-09-2466471Update dependencies
0.3.302025-09-0965735Update dependencies
0.3.292025-08-2465484Update dependencies
0.3.282025-08-1064838Update dependencies
0.3.272025-08-0264368Update dependencies
0.3.262025-07-2664065Update dependencies
0.3.252025-07-1963620Update dependencies
0.3.242025-07-1263245Update dependencies
0.3.232025-07-0562671Update dependencies
0.3.222025-06-2862257Update dependencies
0.3.212025-06-2161754Update dependencies
0.3.202025-06-1561210Update dependencies
0.3.192025-05-2459966Update dependencies
0.3.182025-05-0459562Update dependencies
0.3.172025-04-2658944Update dependencies
0.3.162025-04-1958533Update dependencies
0.3.152025-04-1358038Update dependencies
0.3.142025-04-0557377Update dependencies
0.3.132025-03-2956820Update dependencies
0.3.122025-03-2256337Update dependencies
0.3.112025-03-0955668Update dependencies
0.3.102025-03-0155165Update dependencies
0.3.92025-02-2354636Update dependencies
0.3.82025-02-1554112Update dependencies
0.3.72025-02-0853603Update dependencies
0.3.62025-02-0152554Update dependencies
0.3.52025-01-1851990Update dependencies
0.3.42025-01-1151421Update dependencies
0.3.32024-12-2850380Update dependencies
0.3.22024-12-1449753Update dependencies
0.3.12024-12-1249415Update dependencies
0.3.02024-10-3147327Migrate to Manifest-only
0.2.262024-10-2947802Update dependencies
0.2.252024-10-2847066Update dependencies
0.2.242024-10-1246784Update dependencies
0.2.232024-10-0546486Update dependencies
0.2.222024-09-2846102Update dependencies
0.2.212024-09-2145769Update dependencies
0.2.202024-09-1445546Update dependencies
0.2.192024-09-0745298Update dependencies
0.2.182024-08-3145008Update dependencies
0.2.172024-08-2444720Update dependencies
0.2.162024-08-1744219Update dependencies
0.2.152024-08-1043502Update dependencies
0.2.142024-08-0343246Update dependencies
0.2.132024-07-2742604Update dependencies
0.2.122024-07-2042371Update dependencies
0.2.112024-07-1341880Update dependencies
0.2.102024-07-1041496Update dependencies
0.2.92024-07-0941205Update dependencies
0.2.82024-07-0640850Update dependencies
0.2.72024-06-2540443Update dependencies
0.2.62024-06-2239956Update dependencies
0.2.52024-06-0439058[autopull] Upgrade base image to v1.2.1
0.2.42024-04-1937302Updating to 0.80.0 CDK
0.2.32024-04-1837302Manage dependencies with Poetry.
0.2.22024-04-1537302Base image migration: remove Dockerfile and use the python-connector-base image
0.2.12024-04-1237302schema descriptions
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
</details>