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
• Establish Connection

Section 1: Before You Begin

Zendesk Administrator Role

• The Customer must have the administrator role.

Important Notes

• The values listed below are generated in Zendesk. The Customer will obtain these values in Section 2. 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

This task will be completed by the customer. 

• 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 will 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: Establish Connection

Task 1: Paylocity Representative Generates Link

This Task will be completed by a representative from Paylocity while on a call with the Customer. 

• Step 1: On the left menu, click/expand Integration Management.

• Step 2: Click Apps from the drop-down menu.

• Step 3: Scroll down until you see the Zendesk application. Click the application icon or anywhere within the row where the Zendesk application is located.

• Step 4: You will be taken to the Zendesk screen. Click the App Options button on the top right of your screen.

• Step 5: Select Generate link from the drop-down menu.

• Step 6: A link will appear under the App Options button. Copy the link by highlighting the text, right-clicking, and selecting Copy.

• Step 7: At this point, Paylocity will provide the link to the Customer while on the call and keep the current Cloudsnap page open. 

Task 2: Customer Connects to Zendesk

This Task will be completed by the Customer while still on the call with their Paylocity representative. 

• Step 1: Paste the link into your browser and press Enter. It will take you to the Connect Paylocity to Zendesk screen. The fields are Unique Identifier, Client Secret, and Subdomain URL. These values were obtained in the previous section. 

• Step 2: Click Update App. 

• Step 3: You will see the screen below. Click the Connect button.

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

• Step 4: You will see the screen shown below. This indicates that your credentials were stored for the integration.

Task 3: Paylocity Tech Services Confirms Connection in Cloudsnap

This Task will be completed by a representative from Paylocity while on the call with the Customer. 

• Step 1: After the Customer confirms that their credentials have been stored (Section 3, Task 2, Step 4), click the Test Connection button in Cloudsnap at the top right of your screen. If you are no longer on the Zendesk page in Cloudsnap, follow Steps 1-3 in Task 1 of this section. 
  • If successful, a green checkmark will appear to the left of the Test Connection button. 
    • If the connection succeeds, this indicates that the Zendesk connection has been established, and the connection can be used for Zendesk.
    • If the connection fails, check and correct the Zendesk credentials.