**Estimated time to complete: **15 minutes
If you encounter any problems, please contact your support team or firstname.lastname@example.org.
How to Setup the Connector
Step 1. Log into Zendesk.
You will need an admin account to create the OAuth client and authorize it when connecting it within Clarity.
Step 2. Click the Gear Icon > Admin.
Step 3. Click Settings now in Admin Center.
Step 4. Click Try settings in Admin Center.
Step 5. Click Apps and Integrations > Zendesk API.
Step 6. Click OAuth Clients > Add OAuth Client.
Step 7. Fill out the form & click Save.
- Client Name: Clarity Security Integration
- Step 12 will use the Client Name, with _ in place of spaces for the client_id
- Description: Leave empty
- Company: Clarity Security
- Logo: Default
- Unique Identifier: Auto-filled. Save for Step 12
- Redirect URL: https://businessname.claritysecurity.io/application/oauthProcessCode/service-identifier
- This will be the name of your tenant, and the unique identifier of the connector you create. You can also find this value in Step 12 below.
If you are connecting Clarity Security to multiple Zendesk environments, change the Unique Identifier field to reflect the specific environment this connector is communicating with.
Example: Zendesk-Enterprise, Zendesk-Individual, Zendesk-Business
Step 8. Click OK to view the secret key.
Copy the Consumer Key and Customer Secret into a secure location. You will not be able to view them again. You will need this for Step 12
Step 9. Log into Clarity Security.
Step 10. Click on Applications and select Marketplace.
Step 11. Scroll to find Zendesk and click Connect.
Step 12. Fill out the Connect App form with the proper credentials.
Complete the App Settings form. Details for fields common to all applications can be found in the following article: Common App Configuration Steps
These values are from Steps 7 and 8 above.
Step 13. Fill out the App Settings form.
Complete the App Settings form. Details for each field can be found in the following article: Common App Configuration Steps.
Step 14. Fill out the User Settings form.
Complete the User Settings form, and check the table at the top to see if any features are unsupported. Details for each field can be found in the following article: Common App Configuration Steps.
Step 15. Validate Your Selections and Save.
Clicking the Save button will trigger the first full sync for your application (even if you selected Manual syncing). This includes Service Users, Entitlements, Service User Entitlements, Service User Attributes.
If you have any problems, contact your customer success team. You can also get in touch with our general support via email, open a support ticket. Our general support team is available Monday - Friday from 8:00 AM - 6:30 PM CST.