Documentation Index
Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
Use this file to discover all available pages before exploring further.
π Quickstart
Connect to Zendesk with Nango and see data flow in 2 minutes.
Authorize Zendesk
Go to Connections -> Add Test Connection -> Authorize, then log in to Zendesk. Later, youβll let your users do the same directly from your app. Call the Zendesk API
Letβs make your first request to the Zendesk API (fetch a list of tickets). Replace the placeholders below with your secret key, integration ID, and connection ID:curl "https://api.nango.dev/proxy/api/v2/search?query=type:ticket&per_page=10" \
-H "Authorization: Bearer <NANGO-SECRET-KEY>" \
-H "Provider-Config-Key: <INTEGRATION-ID>" \
-H "Connection-Id: <CONNECTION-ID>"
Install Nangoβs backend SDK with npm i @nangohq/node. Then run:import { Nango } from '@nangohq/node';
const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });
const res = await nango.get({
endpoint: '/api/v2/search',
params: {
query: 'type:ticket',
per_page: 10
},
providerConfigKey: '<INTEGRATION-ID>',
connectionId: '<CONNECTION-ID>'
});
console.log(JSON.stringify(res.data, null, 2));
Or fetch credentials dynamically via the Node SDK or API.β
Youβre connected! Check the Logs tab in Nango to inspect requests. Implement Nango in your app
Follow our Auth implementation guide to integrate Nango in your app.To obtain your own production credentials, follow the setup guide linked below.
π Zendesk Integration Guides
Nango maintained guides for common use cases.
Official docs: Zendesk API documentation
π§© Pre-built syncs & actions for Zendesk
Enable them in your dashboard. Extend and customize to fit your needs.
Articles
| Function name | Description | Type | Source code |
|---|
list-articles | List Zendesk Help Center articles with pagination | Action | π Github |
| Function name | Description | Type | Source code |
|---|
get-group | Retrieve a group by ID. | Action | π Github |
list-groups | List support groups | Action | π Github |
groups | Sync support groups from Zendesk. | Sync | π Github |
Help Center
| Function name | Description | Type | Source code |
|---|
create-category | Create a Zendesk Help Center category | Action | π Github |
create-section | Create a Zendesk Help Center section | Action | π Github |
get-article | Retrieve a Zendesk Help Center article by ID. | Action | π Github |
| Function name | Description | Type | Source code |
|---|
list-macros | List ticket macros available to the account | Action | π Github |
Organizations
| Function name | Description | Type | Source code |
|---|
create-organization | Create an organization in Zendesk Support | Action | π Github |
get-organization | Retrieve an organization by ID. | Action | π Github |
list-organizations | List organizations in Zendesk Support. | Action | π Github |
update-organization | Update an existing organization in Zendesk. | Action | π Github |
Ticket Fields
| Function name | Description | Type | Source code |
|---|
get-ticket-field | Retrieve a ticket field by ID. | Action | π Github |
| Function name | Description | Type | Source code |
|---|
get-ticket-form | Retrieve a ticket form by ID. | Action | π Github |
list-ticket-forms | List ticket forms for the account. | Action | π Github |
Tickets
| Function name | Description | Type | Source code |
|---|
create-ticket | Create a support ticket in Zendesk | Action | π Github |
get-ticket-comments | List comments for a ticket. | Action | π Github |
get-ticket | Retrieve a ticket by ID. | Action | π Github |
list-ticket-fields | List ticket fields for the account. | Action | π Github |
list-tickets | List tickets in Zendesk Support | Action | π Github |
search-tickets | Search tickets with Zendesk search syntax. | Action | π Github |
update-ticket | Update an existing ticket and optionally add a comment | Action | π Github |
| Function name | Description | Type | Source code |
|---|
create-user | Create a user in Zendesk Support. | Action | π Github |
delete-user | Delete a Zendesk user | Action | π Github |
get-user | Retrieve a user by ID. | Action | π Github |
list-users | List users in Zendesk Support. | Action | π Github |
update-user | Update an existing user. | Action | π Github |
| Function name | Description | Type | Source code |
|---|
list-views | List ticket views for the account | Action | π Github |
| Function name | Description | Type | Source code |
|---|
articles | Sync Zendesk Help Center articles | Sync | π Github |
categories | Sync Zendesk Help Center categories | Sync | π Github |
macros | Sync ticket macros from Zendesk | Sync | π Github |
organizations | Sync organizations from Zendesk using incremental export | Sync | π Github |
sections | Sync Zendesk Help Center sections | Sync | π Github |
ticket-comments | Sync comments for tickets in scope | Sync | π Github |
ticket-fields | Sync ticket field definitions from Zendesk | Sync | π Github |
ticket-forms | Sync ticket forms from Zendesk | Sync | π Github |
tickets | Sync tickets from Zendesk Support | Sync | π Github |
users | Sync users from Zendesk Support using incremental cursor-based exports | Sync | π Github |
views | Sync ticket views from Zendesk | Sync | π Github |