Connect to Zendesk

Overview

This guide will walk you through establishing a connection required for the Zendesk integration. It is divided into three sections. 

• Before You Begin
• Prepare Zendesk Account
• Create Custom User Field
• Establish Connection

Section 1: Before You Begin

Zendesk Administrator Role

• You'll need to have the Administrator role in Zendesk.

Important Notes

• The values listed below are generated in Zendesk. See Section 2 for instructions. It is important to copy and store these values somewhere safe until they are ready to use in Section 3. The Client Secret will only be shown once in Zendesk.
  
  • • Unique Identifier
    • Client Secret
    • Subdomain URL

Section 2: Prepare Zendesk Account

Task 1: Add OAuth Client, Add Redirect URIs, and Obtain Unique Identifier & Client Secret

• Step 1: Log in to your Zendesk account.
• Step 2: In the Menu located near the top right of your screen, click the icon shown in the screenshot below.

 

• Step 3: From the drop-down, select Admin Center.

• Step 4: In the left navigation menu, select Apps and integrations.

• Step 5: Under APIs in the left navigation menu, select Zendesk API.

• Step 6: Select OAuth Clients from the menu located at the top of your screen.

• Step 7: To add a new OAuth client click the Add OAuth client button on the right of your screen. 

• Step 8: On the next screen, fill out the fields highlighted in the screenshot below. Then, click the Save button.
  • • Client Name: Paylocity
    • Description: Paylocity Integration
    • Company: Enter the company name
    • Unique Identifier: This is auto-populated
    • Redirect URIs:
      • • https://app.cloudsnap.com/oauth_flow/complete
        • https://app.csnapstage.com/oauth_flow/complete

• Step 9: The below pop-up will appear reminding you that you will only be able to view the secret once. Click the OK button.

• Step 10: On the next screen, the Unique Identifier and the Secret will be displayed. It is important to copy and store these values somewhere safe until they are ready to use in Section 3. The Client Secret will only be shown once in Zendesk. Then, click the Save button.

Task 2: Obtain Subdomain URL

• Step 1: Next, you'll need to obtain your Subdomain URL. In the address bar, copy the first part of the URL as shown in the screenshot below. This is the Subdomain URL and it will be needed to complete the next section. Make sure to copy it and save it somewhere accessible.
  • • Note: The below screenshot is just an example, and your Subdomain URL will be different. 

Section 3: Create Custom User Field

Task 1: Create Custom User Field

It’s important the Paylocity Employee ID is stored in Zendesk. This will ensure there's a unique value linking employees between the applications. This task creates a Custom User Field and will generate a Field Key. The Field Key is required for the integration setup and will be provided to Paylocity. Admin privileges are required to create this field.

• Step 1: Open Zendesk.
• Step 2: On the dropdown on the right side of the screen, click Admin Center.

• Step 3: On the navigation list on the left side of the User field window that opens, click User fields. 

• Step 4: Click the Add Field button.

• Step 5: On the Add field window that opens, click the Text button.

• Step 6: On the Text field window that opens, enter the Display name.
• Since this field will store the Paylocity Employee ID, we recommend you name it something like, Paylocity ID, Payroll ID, etc.

The Field key is automatically generated when the Display name is entered.

The Preview in the upper right corner displays what the agents see when they interact with this field.

• Step 7: Click Save.

• The User fields window displays the new field.

• Step 8: Provide the new Field key to Paylocity.

• Step 9: On the Customer tab, in the lower left corner of the screen, the field can be edited in the UI.

Section 4: Establish Connection

Task 1: Make connection in Marketplace

• Step 1: If your Paylocity Marketplace wizard is still open, enter the values copied from the previous Sections into the authentication fields and click Authenticate (see step 5 below). If you've navigated away and need to reopen the wizard, return to Paylocity and navigate to the ☰ Workspace selection menu in the upper-left corner of the page. Select Marketplace.

• Step 2: Select My Integrations.

• Step 3: Select Drafts.

• Step 4: Select the Continue Setup button on the Zendesk app tile.

• Step 5: Enter the values copied from the previous Sections into the authentication fields and click Authenticate.

• Step 6: You will be taken back to Zendesk and prompted to authorize the integration. Click the Allow button.