Connect to Deputy

Overview

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

• Before You Connect
• Register Connection in Deputy
• Establish Connection

Section 1: Before You Connect

Preconditions

• You must be a Deputy administrator to set up the connection.
• The customer must register the Paylocity connection in Deputy by adding a new OAuth client. See Section 2 for instructions.
• The Deputy Client ID and Client Secret are required in order to establish the connection. See Section 2 for instructions. 

Section 2: Register Connection in Deputy

Task 1: Customer Registers the Paylocity Connection in Deputy by Adding New OAuth Client

This Task will be completed by the customer. 

• Step 1: Click this link, and log in to Deputy: https://once.deputy.com/my/oauth_clients
• Step 2: Click the New OAuth Client button located at the top left of your screen. 

• Step 3: You will be taken to the New OAuth Client form. Enter the following information:
  • Name: Paylocity
  • Redirect URI: https://app.cloudsnap.com/oauth_flow/complete

• Step 4: Click the Save This OAuth Client button located at the top left of your screen. 

• Step 5: On the next screen, the Client ID and Client Secret will be displayed. These values will be needed in order to complete Section 3.

• Note: The Client ID and Client Secret can be viewed later by visiting the link below, then clicking the magnifying glass icon to the left of the OAuth client. 
  • https://once.deputy.com/my/oauth_clients

Task 2: Customer Obtains the Company Name and Location within the URL

• Step 1: Once logged into Deputy, look at the URL address bar at the top of your screen. It will contain the Company Name and Location. Save this value for use in Section 3. 
  • • For example, in the screenshot below, Paylocity is the company name, and na is the Location. Together, Paylocity.na would be used in the following section. 

• • 
    
    •  Note: Your Company Name and Location will not be Paylocity.na, but you can find it by reviewing the URL address bar once in Deputy. 

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 Deputy application. Click the application icon or anywhere within the row where the Deputy application is located.

• Step 4: You will be taken to the Deputy 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 Deputy

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. It will take you to the Connect Paylocity to Deputy screen. Enter the fields shown in the screenshot below.
  • Company URL: See Section 2 > Task 2 > Step 1
  • Client Secret: See Section 2 > Task 1 > Step 5
  • Client ID: See Section 2 > Task 1 > Step 5

• Step 2: Click Update App. 

• Step 3: On the next screen, click the Connect button.

• Step 4: Select the organization you wish to connect from the drop-down menu. Then, click Authorize.

 

• Step 5: You will see the screen below. This indicates that the credentials have been stored. 

 

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 (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 Deputy 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 Deputy connection has been established, and the connection can be used for Deputy workflows.
    • If the connection fails, check and correct the Deputy credentials.