Skip to main content
You must be an administrator of your Zendesk account to register an OAuth client.

​
Find your subdomain

Your subdomain is the unique identifier in your Zendesk URL.

  • Check your browser address bar when signed in to Zendesk.
  • Format: https://{subdomain}.zendesk.com
  • Example: if your URL is https://acme.zendesk.com/agent/home, your subdomain is acme
  • Enter it in the Subdomain field in StackOne Hub.

​
Registering an OAuth client

An OAuth client registered in your own Zendesk account lets StackOne request access on your behalf.

1

Sign in to Zendesk

Sign in to your Zendesk account.

  • Enter your subdomain in the yoursubdomain.zendesk.com field and click Sign in.
The Zendesk sign-in page with the subdomain field and Sign in button highlighted
2

Open Admin center

In the top bar, click the product switcher labeled Support, then select Admin center.

The Zendesk product menu with Admin center highlighted
3

Open OAuth clients

In Admin center, click Apps and integrations in the sidebar, then select APIs > OAuth clients and click Add OAuth client.

The OAuth clients page with the Add OAuth client button highlighted
4

Enter the client details

Fill in the details that users see when they are asked to grant access to your application.

  • Name: the name users see when asked to grant access, for example StackOne Integration.
  • Description: a short description of the app, for example Integration with StackOne.
  • Company: your company name.
  • Logo: optional. Upload a square JPG, GIF, or PNG.
The Add OAuth client form with the Name, Description, and Company fields highlighted
5

Set the identifier, client kind, and redirect URL

The Identifier is auto-populated from the name. You can edit it, but it must be unique. Copy it, it is your Client ID.

  • Client kind: select Confidential.
  • Redirect URLs: https://api.stackone.com/connect/oauth2/zendesk/callback
The Add OAuth client form with the Identifier, Client kind, and Redirect URLs fields highlighted
6

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 and select the scopes listed below. Leave the field empty to allow any scope, or select only the scopes StackOne needs for the actions you use.

The Scopes field with the selected scopes highlighted
7

Save and copy the secret

Click Save. The Secret field now shows the generated secret. Click Copy and store it securely for use later.

  • The secret is shown in its entirety only once and cannot be retrieved later. It won’t be shown in full again after you click Save or leave this page. You can regenerate a secret on the Edit page.
  • Click Save again to finish creating the client.
The generated Secret with the Copy button highlighted and the secret value masked

​
Entering the credentials in StackOne

The Identifier and Secret from the OAuth client are the credentials StackOne uses to request access on your behalf.

  • Enter the Identifier in the Client ID field in StackOne Hub.
  • Enter the Secret in the Client Secret field in StackOne Hub.
  • Scopes is optional. Leave it empty to request the full set the connector needs, or enter a space-separated subset. Every scope you enter must be included in the client’s Scopes, otherwise authorization fails.

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • Subdomain
  • Client ID
  • Client Secret
  • Scopes (Optional)
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.