Skip to main content
You need a Zendesk developer account (subdomain prefixed d3v-) where you are an administrator, and a proof of business document.

Registering a local OAuth client

Zendesk creates a global OAuth client by converting a local OAuth client that you register first in your developer account.

If Zendesk has already converted an OAuth client of yours to a global client, use that client and skip the rest of the steps. Copy the Identifier to Client ID in your Connector Profile. Copy the Secret to Client Secret in your Connector Profile.

1

Enter the client details

Sign in to your Zendesk developer account. If you do not have one, see Getting a trial or sponsored account for development.

Zendesk shows this information to users when they are asked to grant access, and it cannot be changed after the client is globalized.

  • In the top bar, click the product switcher labeled Support.
  • Select Admin center.
  • In the sidebar, select Apps and integrations > APIs > OAuth clients.
  • Click Add OAuth client.
  • Name: StackOne Integration
  • Description: Short summary of your app
  • Company: Your company name
  • Logo: Your company logo
The Add OAuth client form with the Name, Description, and Company fields highlighted
2

Set the identifier, client kind, and redirect URL

Zendesk reserves identifiers that start with zdg- for global OAuth clients.

  • Identifier: Replace the suggested value with one that starts with zdg-
  • Client kind: Confidential
  • Redirect URLs: the Callback URL from your Connector Profile
The Add OAuth client form with the Identifier, Client kind, and Redirect URLs fields highlighted
3

Select scopes

Enables actions: Add Tags, Check Brand Host Mapping Validity, Check Host Mapping Validity, Count Organizations, Count Tags, Count Tickets, Count Users, Create Brand, Create Group, Create Group Membership, Create Organization, Create Organization Membership, Create Ticket, Create Ticket Field, Create Ticket Form, Create Trigger, Create User, Delete Brand, Delete Brand Logo, Delete Group, Delete Group Membership, Delete Organization, Delete Organization Membership, Delete Ticket, Delete Ticket Field, Delete Ticket Form, Delete Ticket Trigger, Delete User, List Audits For Ticket, List Brands, List Group Memberships, List Groups, List Organization Memberships, List Organizations, List Resource Tags, List Search Results, List Tags, List Ticket Comments, List Ticket Fields, List Ticket Forms, List Ticket Triggers, List Tickets, List Users, Merge Tickets Into Target Ticket, Remove Tags, Search Organizations, Search Tags, Search Ticket Triggers, Search Users, Set Tags, Show Attachment, Show Brand, Show Group, Show Group Membership, Show Organization, Show Organization Membership, Show Self, Show Ticket, Show Ticket Field, Show Ticket Form, Show Ticket Trigger, Show User, Update Brand, Update Brand Logo, Update Group, Update Organization, Update Ticket, Update Ticket Field, Update Ticket Form, Update Ticket Trigger, Update User, Upload Files

In Scopes, click Select scopes.

  • Select each scope listed.
The Scopes field with the selected scopes highlighted
4

Save the client and copy the credentials

Click Save. The Secret field now shows the generated secret.

  • Copy the Identifier to Client ID in your Connector Profile.
  • Click Copy next to Secret. Zendesk shows the secret in full only once.
  • Copy the Secret to Client Secret in your Connector Profile.
  • Click Save again to finish creating the client.
The generated Secret with the Copy button highlighted and the secret value masked

Requesting a global OAuth client

Ask Zendesk to convert your local OAuth client into a global client that works across all Zendesk accounts. Zendesk keeps the client’s Identifier and Secret when it converts the client.

1

Complete the request form

Sign in to the Zendesk Marketplace Portal.

Only submit a global OAuth request if the client is ready for production. Client information such as company, description, and logo can’t be changed.

  • If you do not have an account, click Register.
  • In the sidebar, click Global OAuth.
  • Click Request new OAuth.
  • Zendesk Support account: The part of your developer subdomain after d3v-
  • Unique identifier: The part of your client’s Identifier after zdg-
  • Select I confirm the company details related to this OAuth client are correct.
  • Proof of business: An incorporation document or company registration
  • Select the checkbox to agree to the Zendesk Partner and Developer Terms and Privacy Policy.
  • Click Send request.
  • Zendesk reviews each request manually and does not publish a turnaround time. Track progress through the ticket reference in the confirmation email.
The Request new OAuth form with the account, identifier, and Send request fields highlighted

Create the StackOne Connector Profile

1

Create a Connector Profile

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.
2

Link an Account

Once the Connector Profile is created, continue to link an account.