Adding your Zendesk credentials to Oomnitza

Zendesk supports two types of authentication for its API— Basic and OAuth.  Select the authentication that meets your security requirements.

Best practice
For the integration with Oomnitza, create a dedicated user account.

Basic authentication

If you choose Basic Authentication, you are required to do the following in Zendesk:

1. Log in to your Zendesk account. 
2. Go to Admin Center>Apps and integrations>Zendesk API
3. In the Settings tab, click Add API token. Make sure to copy and store your API token.

See Zendesk: Generating a new API token

Adding the Basic authentication credentials to Oomnitza

When you add your Basic authentication credentials to Oomnitza, your Username consists of your Zendesk email followed by a forward slash (/) and the word token: 

 [e-mail]/token 

Your Password is your API Key.

To add the credentials to Oomnitza, complete the following steps:

1. Click Configuration>Security>Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward button > to select the integration.
4. Enter the user name and password of your account
5. Click Create.

Integration not in the list? Click Advanced Mode and complete these steps:

1. Add the information details.
2. Click the AUTHORIZATION tab.
3. Ensure that Basic Auth is selected as the authorization type.
4. Enter the username and password.
5. Click Create. 

OAuth Authentication

Zendesk OAuth 

To set up Zendesk OAuth in Oomnitza, you will need the following :

• Your Client ID

• The Secret for your client ID.

1. Log in to your Zendesk account. 
2. Go to Admin Center>Apps and integrations>APIs>Zendesk API>OAuth Clients.
3. Click Add OAuth client.
4. Enter the client details and supply the following redirect URL: https://generic-oauth2-proxy.oomnitza.com/oauth2/redirect_url 
5. Set the Client Kind to Confidential.
6. Copy and store your client ID and client secret.

For further information, refer to Zendesk: Creating an OAuth client.

Scope

For information on scopes refer to Zendesk: Scope. Some commonly used scopes include:

• "users : read" - for loading the list of users
• "read" - for SaaS user role integration
• "read write" - for the various API presets

Zendesk Subdomain

If your Zendesk URL is https://mycompany.zendesk.comyour subdomain is mycompany.

Adding the OAuth credentials to Oomnitza

To use OAuth authentication in Oomnitza, complete the following steps:

Make life easier and add your credentials to Oomnitza before you create the integration.  

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward arrow > to select the integration.
4. Enter your client credentials and any other additional information.
5. Click Authenticate. You are prompted to log in to authorize your request.
6. Click CREATE.

1. Add the information details.
2. Click the AUTHORIZATION tab.
3. Ensure that OAuth 2.0 is selected as the Authorization type.
4. Ensure that Zendesk is selected from the SaaS list.
5. Enter your Zendesk subdomain. 
6. Enter the Client ID generated during OAuth2 setup.
7. Enter the Client Secret generated during OAuth2 setup.
8. Enter the Scope of your integration.
9. Click Authenticate. You are prompted to log in to authorize your request.
10. Click CREATE. 

Next

Use the credentials that you added to create an extended integration for Zendesk users. See Creating an extended integration for Zendesk users.