Articles in this section

Set up a connection to Zendesk

Naga Sri Hari Gonaboyina
Updated

Zendesk is a customer service platform that enables businesses to manage and resolve customer inquiries efficiently through multiple channels, including email, chat, and social media.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all the required * authentication settings:

Setting

Instructions

Name your connection * 

Enter a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type * 

Select your Zendesk API type: 

  • Zendesk Support: Get tickets, users, organizations, custom objects, and manage ticket workflows.

  • Zendesk Sell: Get sell-powered applications for the web, mobile, and desktop.

API type: Zendesk Support

Subdomain * 

Enter your Zendesk Support subdomain. For example, if your Zendesk Support account URL is https://hugesuccess.zendesk.com, then hugesuccess is the subdomain.

Auth type * 

Select your Zendesk Support account authentication type (either Basic, Custom, or Token).

Username *  (only for Basic and Custom API type)

Enter your Zendesk Support account email address.

Password *  (only for Basic API type)

Enter your Zendesk Support account password.

API token * (only for Custom API type)

Enter your Zendesk Support API token.

Multiple layers of protection, including AES 256 encryption, are in place to keep your token safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

How to retrieve the API token 

Access token * (only for Token API type)

Enter your Zendesk Support access token.

Multiple layers of protection, including AES 256 encryption, are in place to keep your token safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

How to retrieve the access token 

API type: Zendesk Sell

OAuth 2.0 client * 

Select the OAuth 2.0 client that stores the client ID and client secret provided to you by Zendesk.

How to retrieve the client ID and client secret  

To add an OAuth 2.0 client and configure your credentials, click the plus ( + ) button. Click the edit ( edit.svg ) button to modify a selected OAuth 2.0 client.

How to create OAuth 2.0 client in integrator.io 

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see custom, and token auth respective universal connector documentation.

How to retrieve the client ID and client secret

  1. Sign in to your Zendesk account.

  2. Navigate to Settings > Preferences > OAuth > Developer apps. 

  3. Click+ Add developer app.

  4. Paste the Callback URL in the Redirect URL field.

  5. Click Save.

  6. Copy the Client ID.

  7. Copy the Client secret.

How to retrieve the API token

  • Sign in to your Zendesk account.

  • Click on Apps and integrations.

  • Navigate to APIs > Zendesk APIs.

  • Click on the Settings tab and ensure that Token access is enabled.

  • Click on Add API token.

  • Add an API description.

  • Copy the API token.

How to retrieve the access token

  • Sign in to your Zendesk account.

  • Click on Apps and integrations.

  • Navigate to APIs > Zendesk APIs.

  • Navigate to OAuth clients > Add OAuth client.

  • Add the required details in the fields.

  • Click Save.

  • Copy the Secret (access token).

Additional references