## 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](https://support.zendesk.com/hc/en-us/articles/4408889192858-Generating-a-new-API-token). ### 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](https://support.zendesk.com/hc/en-us/articles/4408845965210#topic_qk3_d3s_qk). </section>
## 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 `http://mycompany.zendesk.com` then your Zendesk subdomain is `mycompany`. | | **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 `http://mycompany.zendesk.com` then your Zendesk subdomain is `mycompany`. | | **Username** | The email of your Zendesk account followed by `/token`. For example, if the email of your Zendesk account is `me@example.com` then enter `me@example.com/token`. | | **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 `http://mycompany.zendesk.com` then your Zendesk subdomain is `mycompany`. | | **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. |