Zendesk
API Documentation: Zendesk API Documentation
High-Level Information: The Zendesk API provides a wide range of customer support and operational data, including tickets, users, organizations and knowledge base content as well as metrics and events related to ticket activity and agent performance.
Authentication
This connector supports OAuth 2.0 authentication with Zendesk.
To authenticate:
- In Zendesk, create (or use) an OAuth client:
- Zendesk Admin Center → Apps and integrations → APIs → Zendesk API → OAuth Clients
- Copy the Client ID and Client Secret.
- In the connector setup, provide:
- Subdomain (the
{subdomain}inhttps://{subdomain}.zendesk.com) - Client ID
- Client Secret
- Subdomain (the
- Complete the OAuth consent flow when prompted.
After authorization, the connector verifies access by calling GET /api/v2/users/me.json.
Source Setup Guide
Step 1
in the Edit Source form to the left.
Step 2
Follow the authentication flow (OAuth) in Zendesk's website to grant Extracxt the required permissions.
Step 3
Confirm you can see your email and profile picture, and that the source is Connected.
Connection Setup Guide
After you connect Zendesk to a destination, configure the connection settings:
- Connection Pull Schedule: How frequently Singular extracts data from Zendesk.
- Backfill (Days): How many days of historical data to retrieve on each run.
- Destination-specific settings: Settings such as Dataset Name or Target Schema (varies by destination).
- Schema Migration Policy: How Singular handles schema changes coming from Zendesk.
Connector Information
Schema ERD
Explore the interactive entity relationship diagram for Zendesk.