Requirements

• To connect Mavenoid with Zendesk, an account in Mavenoid with the role Admin is required.

• An agent or admin account needs to be created in Zendesk. See Zendesk’s article Adding agents and admins for information.

  • This account will be used to integrate Mavenoid with Zendesk.

  • The email address [email protected] can be used to configure the account. If preferred, this can also be an email of your own domain.

Connecting Mavenoid with Zendesk

1. Login to Mavenoid
   Log in to the Mavenoid Admin UI, with a user account with Admin role.

2. Navigate to the Integrations tab
   Navigate to the Integrations tab under Settings and click “Connect” on the Zendesk card.
   

3. Select Zendesk Scopes
   Input your subdomain and select a scope. The scope is the scope associated with the OAuth Token that will be used when making API requests to Zendesk.
   
   Available Scopes:

   • Write tickets

     • Scope: "tickets:write"

     • Description: Allowing us to create and update tickets.

   • [Recommended] Write tickets and read all data

     • Scope: "read tickets:write"

     • Description: Allowing us to create and update tickets in batches. This is highly recommended if there’s a possibility that we need to create a few hundred tickets in a short period of time. Zendesk has limitations on how many times you can send a request to their APIs per minute. If this limit is exceeded, then we'll fail to create some tickets

   • Write all data

     • Scope: "read write"

     • Description: Allowing us to integrate more advanced features, such as reading Zendesk contacts.

4. Login to Zendesk
   Click the “Connect to Zendesk” button. This will redirect you to a Zendesk login page, where you need to enter the credentials for the integration account.
   
   Allow Mavenoid to access your Zendesk account.
   
   Finally, you will be redirected back to Mavenoid, where you can that the button label for Zendesk has been updated to “Connected”.