Zendesk Snap Pack
Overview
The Zendesk Snap Pack contains the following Snaps to connect to your Zendesk instance and
perform the respective operations:
- Read Users: Retrieves user records from your Zendesk instance, filtered by ID, group, organization, or role.
- Read Organizations: Retrieves organization records, filtered by ID or external ID.
- Read Groups: Retrieves group records, including assignable groups, filtered by ID or user.
- Read Organization Memberships: Retrieves organization membership records filtered by user, organization, or membership ID.
- Read Group Memberships: Retrieves group membership records filtered by user, group, or membership ID.
- Read Help Center Articles: Retrieves Help Center article records filtered by section, category, label, user, or with incremental export support.
- Read Community Posts: Retrieves community post records filtered by topic or post ID, with optional comment sideloading.
- Read Community Topics: Retrieves community topic records, with an optional filter by topic ID.
- Read User Segments: Retrieves user segment records with optional section and topic sideloading.
- Search Zendesk: Searches across tickets, users, organizations, Help Center articles, and community posts.
- Download Attachment: Downloads a Help Center article attachment as a binary stream.
Prerequisites
- An active Zendesk account with access to the Zendesk API.
- API access enabled in your Zendesk Admin Center (Apps and integrations > APIs > Zendesk API).
- One of the following credentials depending on the account type you use:
- Email address and API token (for the Zendesk Account).
- OAuth2 client ID and client secret (for the Zendesk OAuth2 Account).
- A valid Bearer or Basic authorization token (for the Zendesk Dynamic Token Account).
- Sufficient permissions in Zendesk for the data you intend to access. Agent or Admin role is required for most read operations.
Supported versions
This Snap Pack is tested against Zendesk REST API v2 and the Zendesk Help Center API v2. These are the current stable API versions supported by Zendesk.