Connect to Homebase

Overview

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

• Before You Begin
• Copy API Access Key
• Establish Connection

Section 1: Before You Begin

Preconditions

• The Customer must have the Homebase administrator role.
• The Customer must request and have access to their API Access Key through Homebase prior to moving to Section 2. To request the API Access Key, log in to Homebase, and go to Settings > API Access. Then, click the green Request API Key button.

Section 2: Copy API Access Key

• Step 1: Log in to Homebase. On the left menu, select Settings.

• Step 2: On the submenu, select API Access.

• Step 3: Under API Access, click the Copy button to the right of the API Key field, and paste the value somewhere safe to be used in Section 3. 

Section 3: Establish Connection

Task 1: Paylocity Tech Services Representative Generates Link

• Step 1: Log in to Cloudsnap. 
• Step 2: On the left menu, click/expand Integration Management.

• Step 3: Click Apps under Integration Management. This will take you to the My Apps screen. 

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

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

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

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

• Step 8: 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 Homebase

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 Homebase screen. Enter the values below.
  • Base URL: https://app.joinhomebase.com/api/public
  • Accept: application/vnd.homebase-v1+json
  • Authorization: The value in this field should be entered using the naming convention below. The API Access Key is the value obtained in Section 2. 
    • <Bearer> <API Access Key>
    • Example:
      • API Access Key: 123xyz456abc 
      • Authorization: Bearer 123xyz456abc

• Step 2: Click Update App. 

• Step 3: 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 3), click the Test Connection button in Cloudsnap at the top right of your screen. If you are no longer on the Homebase page in Cloudsnap, follow Steps 2-4 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 Homebase connection has been established, and the connection can be used for Homebase workflows.
    • If the connection fails, check and correct the Homebase credentials.