Zendesk is a comprehensive customer service and engagement platform designed to empower businesses to deliver exceptional support experiences. With its suite of powerful tools and features, Zendesk enables companies to streamline customer interactions, boost efficiency, and foster customer satisfaction.
This guide covers 2 options for authentication:
OAuth
Log in to your Zendesk account
Click on the application tray and click "Admin Centre"
Click "Apps and Integrations"
Click "Zendesk API" under "APIs"
Click "OAuth Clients" and then click "Add OAuth client"
Name your client, give it a description, add a logo and then click "Save"
Click "OK"
Copy your "Unique identifier" and "Secret" to a text editor
Create a Zendesk resource and credentials in Tines
You will need to create:
One Resource: "Zendesk username"
Two Credentials:
Text type: Zendesk password
HTTP Request type: Zendesk OAuth
Resource
Login to your Tines tenant
Navigate to the team that will be using the API and click "Resource"
Click "+ New Resource"
Input the values for the Zendesk resource
Name: Zendesk username
Description: Optional
Builder: Your Zendesk username
Optional
Access: What other teams can also use the resource
Click "Save resource"
Text type
Navigate to the team that will be using the API and click "Credentials"
Click "+ New Credential" and select "Text"
Input the values for the Zendesk credential
Name: Zendesk password
Description: Optional
Value: Your Zendesk password
Optional
Domains: Ensure this credential can only be used when making HTTP requests to specific domains.
Access: What other teams can also use the API
Click "Save"
HTTP Request type
Click "+ New Credential" and select "HTTP Request"
Input the values for the Zendesk credential
Name: Zendesk
Description: Optional
URL:
https://<subdomain>.zendesk.com/oauth/tokens
Content-Type: JSON
Method: post
Payload: Copy the below object and paste into the "Plain code" section:
Replace
<Unique identifier>
with your "Unique identifier" andorganizations:write read
with the client's scopes
{
"grant_type": "password",
"client_id": "<Unique identifier>",
"client_secret": "<<secret>>",
"username": "<<RESOURCE.zendesk_username>>",
"password": "<<CREDENTIAL.zendesk_password>>",
"scope": "organizations:write read"
}Secret: Your "Secret"
Click "Run options", navigate to the
access_token
key and double-click on the key:
Location of token from response: Paste the path to the token in the value pill,
zendesk_oauth.body.access_token
Optional
Domains: Ensure this credential can only be used when making HTTP requests to specific domains
Access: What other teams can also use the API
Click "Save"
Your credential should look like the following:
Basic Authentication
First, get a Zendesk API token
Login to your Zendesk account
Click on the application tray and click "Admin Centre"
Click "Apps and Integrations"
Click "Zendesk API" under "APIs"
Enable "Password access" and "Token access", and click "Add API token"
Name your token, copy your token to a text editor and click "Save"
Lastly, create a Zendesk credential in Tines
Login to your Tines tenant
Navigate to the team that will be using the API and click "Credentials"
Click "+ New Credential" and select "Text"
Input the values for the Zendesk credential
Name: Zendesk
Description: Optional
Value: Your API token
Optional
Domains: Ensure this credential can only be used when making HTTP requests to specific domains.
Access: What other teams can also use the API
Click "Save"
For more on creating credentials in Tines, click here.
You can find a selection of Zendesk stories in the story library