> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Zendesk (Helpdesk)

> Integrate your application with the Zendesk API

## 🚀 Quickstart

Connect to Zendesk with Nango and see data flow in 2 minutes.

<Steps>
  <Step title="Create an integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Zendesk*.
  </Step>

  <Step title="Authorize Zendesk">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to Zendesk. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="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](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        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>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        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));
        ```
      </Tab>
    </Tabs>

    Or fetch credentials dynamically via the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Zendesk Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Zendesk OAuth app](/api-integrations/zendesk/how-to-register-your-own-zendesk-api-oauth-app)\
  Register an OAuth app with Zendesk and obtain credentials to connect it to Nango

* [How do I link my Zendesk account?](/api-integrations/zendesk/connect)\
  Learn how to authenticate with Zendesk and link your account

Official docs: [Zendesk API documentation](https://developer.zendesk.com/api-reference/)

## 🧩 Pre-built syncs & actions for Zendesk

Enable them in your dashboard. Extend and customize to fit your needs.

### Groups

| Function name | Description                       | Type                                           | Source code                                                                                                  |
| ------------- | --------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `groups`      | Sync support groups from Zendesk. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/groups.ts) |

### Others

| Function name         | Description                                                            | Type                                           | Source code                                                                                                                 |
| --------------------- | ---------------------------------------------------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `create-category`     | Create a Zendesk Help Center category                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/create-category.ts)     |
| `create-organization` | Create an organization in Zendesk Support                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/create-organization.ts) |
| `create-section`      | Create a Zendesk Help Center section                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/create-section.ts)      |
| `create-ticket`       | Create a support ticket in Zendesk                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/create-ticket.ts)       |
| `create-user`         | Create a user in Zendesk Support.                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/create-user.ts)         |
| `delete-user`         | Delete a Zendesk user                                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/delete-user.ts)         |
| `get-article`         | Retrieve a Zendesk Help Center article by ID.                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/get-article.ts)         |
| `get-group`           | Retrieve a group by ID.                                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/get-group.ts)           |
| `get-organization`    | Retrieve an organization by ID.                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/get-organization.ts)    |
| `get-ticket-comments` | List comments for a ticket.                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/get-ticket-comments.ts) |
| `get-ticket-field`    | Retrieve a ticket field by ID.                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/get-ticket-field.ts)    |
| `get-ticket-form`     | Retrieve a ticket form by ID.                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/get-ticket-form.ts)     |
| `get-ticket`          | Retrieve a ticket by ID.                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/get-ticket.ts)          |
| `get-user`            | Retrieve a user by ID.                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/get-user.ts)            |
| `list-articles`       | List Zendesk Help Center articles with pagination                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-articles.ts)       |
| `list-groups`         | List support groups                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-groups.ts)         |
| `list-macros`         | List ticket macros available to the account                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-macros.ts)         |
| `list-organizations`  | List organizations in Zendesk Support.                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-organizations.ts)  |
| `list-ticket-fields`  | List ticket fields for the account.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-ticket-fields.ts)  |
| `list-ticket-forms`   | List ticket forms for the account.                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-ticket-forms.ts)   |
| `list-tickets`        | List tickets in Zendesk Support                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-tickets.ts)        |
| `list-users`          | List users in Zendesk Support.                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-users.ts)          |
| `list-views`          | List ticket views for the account                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/list-views.ts)          |
| `search-tickets`      | Search tickets with Zendesk search syntax.                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/search-tickets.ts)      |
| `update-organization` | Update an existing organization in Zendesk.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/update-organization.ts) |
| `update-ticket`       | Update an existing ticket and optionally add a comment                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/update-ticket.ts)       |
| `update-user`         | Update an existing user.                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/actions/update-user.ts)         |
| `articles`            | Sync Zendesk Help Center articles                                      | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/articles.ts)              |
| `categories`          | Sync Zendesk Help Center categories                                    | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/categories.ts)            |
| `macros`              | Sync ticket macros from Zendesk                                        | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/macros.ts)                |
| `organizations`       | Sync organizations from Zendesk using incremental export               | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/organizations.ts)         |
| `sections`            | Sync Zendesk Help Center sections                                      | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/sections.ts)              |
| `ticket-comments`     | Sync comments for tickets in scope                                     | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/ticket-comments.ts)       |
| `ticket-fields`       | Sync ticket field definitions from Zendesk                             | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/ticket-fields.ts)         |
| `ticket-forms`        | Sync ticket forms from Zendesk                                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/ticket-forms.ts)          |
| `tickets`             | Sync tickets from Zendesk Support                                      | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/tickets.ts)               |
| `users`               | Sync users from Zendesk Support using incremental cursor-based exports | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/users.ts)                 |
| `views`               | Sync ticket views from Zendesk                                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/zendesk/syncs/views.ts)                 |

***
