Zendesk
Zendesk setup
API Key
The Zendesk connector supports API authentication with the following pairs of credentials:
A Zendesk account email and password.
A Zendesk account email and API token.
Generate an API token
To generate an API token for your Zendesk account, please see Zendesk's API documentation.
OAuth2
The Zendesk connector supports OAuth2 authentication with the following information
Unique Identifier.
Client Secret.
The Scopes requested of your zendesk application.
To authenticate your OAuth2 Application, you need to create an OAuth Client in Zendesk. To create an OAuth2 Client for your Zendesk Account, see Zendesk's OAuth2 Client Setup Guide.
Cyclr Setup
There are two ways to install the connector into an account in Cyclr; you can use a password or an API token.
Install with email and password
Enter the following values when you install the Zendesk connector within an account:
Field | Value |
|---|---|
Zendesk Subdomain | The Zendesk subdomain your Zendesk account exists under. For example, if your Zendesk account is under |
Username | The email of your Zendesk account. |
Password | The password of your Zendesk account. |
Install with email and API token
Enter the following values when you install the Zendesk connector within an account:
Field | Value |
|---|---|
Zendesk Subdomain | The Zendesk subdomain your Zendesk account exists under. For example, if your Zendesk account is under |
Username | The email of your Zendesk account followed by |
Password | The API token generated for your Zendesk account. |
Install with OAuth2
Enter the following values when you install the Zendesk connector within an account
Field | Value |
|---|---|
Zendesk Subdomain | The Zendesk subdomain your Zendesk account exists under. For example, if your Zendesk account is under |
Unique Identifier | The field is auto-populated with a reformatted version of the name you entered for your zendesk app. |
Client Secret | The Client Secret of your zendesk application. |
Use Webhooks
In order to use Zendesk webhooks, your Zendesk connector needs to be authenticated against the account of a Zendesk Admin.
Update deprecated Zendesk webhooks
Zendesk will soon deprecate HTTP targets within their API. To be compatible with this change, Cyclr has created new webhook methods that use webhooks instead of HTTP targets. As this is a Zendesk change, it means you have to replace these methods manually within your cycles. Information on Zendesk's deprecation of HTTP targets and conversion to webhooks can be found here.
Remove deprecated webhooks
To remove deprecated Zendesk webhooks from a cycle:
Go to a cycle that uses a Zendesk webhook.
Select Stop to stop the cycle, and then select Finish and Stop to allow any transactions to complete.
Select Delete step to delete the webhook and then select OK to confirm the deletion. This automatically removes targets and triggers associated with the webhook from Zendesk.
Add new webhooks
To add the new Zendesk webhooks to a cycle:
Find the updated Zendesk webhook methods under Application Connectors > Zendesk > Webhooks in the cycle builder.
Drag the required webhook onto the cycle builder.
Connect the webhook back to the cycle.
Select Step setup for each step within the cycle and check for invalid mappings. Fix as required.
Select Run to restart the cycle. This automatically adds webhooks and triggers associated with the webhook to Zendesk.