Skip to main content

Zendesk Support

Zendesk is a comprehensive customer service platform that helps businesses manage customer support tickets, knowledge bases, and customer interactions. The Zendesk Support API enables integration with support workflows, ticket management, and customer data synchronization.

Zendesk Support icon

Power end-to-end data operations for your Zendesk Support API with Nexla. Our bi-directional Zendesk Support connector is purpose-built for Zendesk Support, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Zendesk Support or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Zendesk Support workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Before creating a Zendesk Support credential, you need to obtain your Zendesk subdomain and authentication credentials from your Zendesk account. Zendesk Support supports two authentication methods: Access Token authentication and Username/Password authentication.

Access Token Authentication​

Access Token authentication provides secure, token-based access to the Zendesk Support API. This method requires an API token that can be generated in your Zendesk account settings.

To obtain your Zendesk Access Token, follow these steps:

  1. Sign in to your Zendesk account using your administrator credentials.

  2. Navigate to Admin > Apps and integrations > APIs > Zendesk API in your Zendesk dashboard.

  3. In the Zendesk API settings, locate the Token Access section and click Add API token or Generate new token.

  4. Enter a description for the token (e.g., "Nexla Integration") and click Create to generate the API token.

  5. Copy the API token value immediately, as it may not be accessible again after you navigate away from the page.

  6. Store the API token securely, as you will need it to configure your Nexla credential. The API token is sensitive information and should be kept confidential.

The Access Token is sent in the Authorization header as a Bearer token for all API requests to the Zendesk Support API. If your API token is compromised, you should immediately revoke it in your Zendesk account settings and generate a new one. For detailed information about Zendesk API authentication, see the Zendesk API documentation.

Username/Password Authentication​

Username/Password authentication uses your Zendesk account credentials to authenticate API requests. This method can use either your account password or an API token appended to your email address.

To use Username/Password authentication, you need:

  1. Zendesk Subdomain: Your Zendesk subdomain (e.g., yourcompany from https://yourcompany.zendesk.com).

  2. Username/Email: Your Zendesk account email address. If you're using an API token instead of a password, append /token to your email address (e.g., example@domain.com/token).

  3. Password/Token: Your Zendesk account password or API token. If using an API token, use the token value as the password.

For detailed information about Zendesk API authentication, see the Zendesk API documentation.

Authenticate​

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Zendesk Support

ZendeskSupportCred.png

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Zendesk Support supports two authentication methods: Access Token authentication and Username/Password authentication. Select the method that best suits your needs, and follow the corresponding steps below to configure it.

Zendesk Support Authentication Methods

Use Access Token authentication for secure, token-based access to the Zendesk Support API. This method requires an API token generated in your Zendesk account settings.

  1. Enter your Zendesk subdomain in the **Zendesk subdomain (https://.zendesk.com)** field. This should be your Zendesk subdomain (e.g., `yourcompany` from `https://yourcompany.zendesk.com`). The subdomain determines which Zendesk instance will be accessed.
  2. Select the API type from the **Zendesk Core Client ID** pulldown menu. Choose **Zendesk Core API** for standard Zendesk Support API access, or **Zendesk Chat API** for Zendesk Chat API access. The API type determines which Zendesk API will be used.
  3. Select the scope from the **Scope** pulldown menu. Choose **read** for read-only access, or **read write** for read and write access. The scope determines the level of access granted to the API token.
  4. Click the **Authorize** button to initiate the OAuth authorization flow. You will be redirected to Zendesk to grant permissions to Nexla. After authorization, the Access Token will be automatically populated in the credential configuration.
  1. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Zendesk Support connector tile, then select the credential that will be used to connect to the Zendesk Support instance, and click Next; or, create a new Zendesk Support credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Zendesk Support endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get All Tickets

This endpoint template fetches all tickets in your Zendesk Support account. Use this template when you need to access ticket information, support data, or ticket metadata for analysis, reporting, or integration purposes.

  • This endpoint automatically fetches all tickets from your Zendesk Support account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses link-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of ticket data.

This endpoint returns all tickets from your Zendesk Support account, including ticket IDs, subjects, descriptions, statuses, priorities, and other ticket metadata. The endpoint uses link-based pagination (following the next_page URL) to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of ticket data.

For detailed information about tickets, API response structures, pagination, and available ticket data, see the Zendesk Support API documentation.

Get All Users

This endpoint template fetches all users in your Zendesk Support account. Use this template when you need to access user information, user profiles, or user metadata for analysis, reporting, or integration purposes.

  • This endpoint automatically fetches all users from your Zendesk Support account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses link-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of user data.

This endpoint returns all users from your Zendesk Support account, including user IDs, names, email addresses, roles, and other user metadata. The endpoint uses link-based pagination (following the next_page URL) to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of user data.

For detailed information about users, API response structures, pagination, and available user data, see the Zendesk Support API documentation.

Get All Groups

This endpoint template fetches all groups in your Zendesk Support account. Use this template when you need to access group information, group membership, or group metadata for analysis, reporting, or integration purposes.

  • This endpoint automatically fetches all groups from your Zendesk Support account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses link-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of group data.

This endpoint returns all groups from your Zendesk Support account, including group IDs, names, descriptions, and other group metadata. The endpoint uses link-based pagination (following the next_page URL) to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of group data.

For detailed information about groups, API response structures, pagination, and available group data, see the Zendesk Support API documentation.

Get All Ticket Audits

This endpoint template fetches all audit information for each ticket. Audits are a read-only history of all updates to a ticket. When a ticket is updated in Zendesk Support, an audit is stored. Use this template when you need to access ticket audit history, change tracking, or audit metadata for analysis, reporting, or integration purposes.

  • This endpoint automatically fetches all ticket audits from your Zendesk Support account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses link-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of audit data.

This endpoint returns all ticket audits from your Zendesk Support account, including audit IDs, ticket IDs, timestamps, changes, and other audit metadata. Audits are a read-only history of all updates to a ticket. The endpoint uses link-based pagination (following the after_url URL) to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of audit data.

For detailed information about ticket audits, API response structures, pagination, and available audit data, see the Zendesk Support API documentation.

Get All Organizations

This endpoint template fetches all organizations in your Zendesk Support account. Use this template when you need to access organization information, organization data, or organization metadata for analysis, reporting, or integration purposes.

  • This endpoint automatically fetches all organizations from your Zendesk Support account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses link-based pagination to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of organization data.

This endpoint returns all organizations from your Zendesk Support account, including organization IDs, names, domains, and other organization metadata. The endpoint uses link-based pagination (following the links.next URL) to handle large result sets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of organization data.

For detailed information about organizations, API response structures, pagination, and available organization data, see the Zendesk Support API documentation.

Count Tickets

This endpoint template returns an approximate count of tickets in the account. If the count exceeds 100,000, it is updated every 24 hours. Use this template when you need to access ticket counts, statistics, or count metadata for analysis, reporting, or integration purposes.

  • This endpoint automatically returns an approximate count of tickets from your Zendesk Support account. No additional configuration is required beyond selecting this endpoint template. The endpoint does not use pagination as it returns a single count value.

This endpoint returns an approximate count of tickets in your Zendesk Support account. If the count exceeds 100,000, it is updated every 24 hours. The endpoint returns a single count value, not a list of tickets.

For detailed information about ticket counts, API response structures, and available count data, see the Zendesk Support API documentation.

Show Ticket

This endpoint template returns a number of ticket properties for a specific ticket. Use this template when you need to access detailed ticket information, ticket properties, or ticket metadata for a specific ticket ID for analysis, reporting, or integration purposes.

  • Enter the Ticket ID in the Ticket ID field. This should be the ID of the ticket whose properties you want to retrieve. The Ticket ID determines which ticket's properties will be retrieved.

This endpoint returns a number of ticket properties for a specific ticket from your Zendesk Support account, including ticket ID, subject, description, status, priority, and other ticket metadata. The endpoint returns a single ticket record, not a list of tickets.

For detailed information about ticket properties, API response structures, and available ticket data, see the Zendesk Support API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Zendesk Support data sources can also be manually configured to ingest data from any valid Zendesk Support API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Zendesk Support API endpoints typically follow the pattern https://{subdomain}.zendesk.com/api/v2/{endpoint_path}, where {subdomain} is your Zendesk subdomain. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Zendesk Support data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Zendesk Support destination, and select the Send to Destination option from the menu. Select the Zendesk Support connector from the list of available destination connectors, then select the credential that will be used to connect to the Zendesk Support instance, and click Next; or, create a new Zendesk Support credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Zendesk Support endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Ticket

This endpoint template allows you to create tickets from Nexset records. Each record results in an API call to Zendesk. Use this template when you need to automatically create tickets based on data from your Nexla flows.

  • This endpoint sends data as JSON in the request body to create new tickets. Each record from your Nexset will be sent as a separate API request to create a ticket. The request body should contain the ticket data in the format required by the Zendesk Support API, including all required fields for ticket creation.

This endpoint sends data as JSON in the request body to create new tickets in your Zendesk Support account. Each record from your Nexset will be sent as a separate API request to create a ticket. The request body should contain the ticket data in the format required by the Zendesk Support API, including all required fields for ticket creation.

The ticket structure must match the Zendesk Support API's expected format. Ensure your ticket data includes all required fields. For detailed information about ticket creation, request body formats, and available ticket properties, see the Zendesk Support API documentation.

Create Many Tickets

This endpoint template allows you to bulk create tickets from Nexset records. Groups of 100 tickets will be sent to Zendesk as a single API call of many tickets. Use this template when you need to efficiently create multiple tickets in bulk based on data from your Nexla flows.

  • This endpoint sends data as JSON in the request body to bulk create tickets. Groups of 100 tickets will be sent to Zendesk as a single API call. The request body should contain an array of ticket data in the format required by the Zendesk Support API, including all required fields for ticket creation.

This endpoint sends data as JSON in the request body to bulk create tickets in your Zendesk Support account. Groups of 100 tickets will be sent to Zendesk as a single API call, making it more efficient than creating tickets individually. The request body should contain an array of ticket data in the format required by the Zendesk Support API, including all required fields for ticket creation.

The ticket structure must match the Zendesk Support API's expected format. Ensure your ticket data includes all required fields. For detailed information about bulk ticket creation, request body formats, and available ticket properties, see the Zendesk Support API documentation.

Manual configuration​

Zendesk Support destinations can also be manually configured to send data to any valid Zendesk Support API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The Zendesk Support APIs typically expect JSON format for most operations. For create operations, the URL typically follows the pattern https://{subdomain}.zendesk.com/api/v2/{resource_type}, where {subdomain} is your Zendesk subdomain and {resource_type} is the type of resource you want to create (e.g., tickets, users). For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Zendesk Support endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Zendesk Support endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.