Paylocity API

Step 1: Review the Demo Video

Please review this demo video that shows webhook functionality with Paylocity:

Step 2: Configure API Connectivity

You will need to request Paylocity for API credentials. This link provides more info on the information you will receive when API Access is granted i.e., client id and client secret.

1. Request Paylocity API credentials. You will receive the client id and client secret from Paylocity.

2. Confirm the connector purpose. The Paylocity connector lets you connect to a Paylocity instance and access Paylocity HR resources using their published APIs.

3. Choose the correct base URL (doc ref).

   • NextGen API — Production: https://dc1prodgwext.paylocity.com

   • NextGen API — Sandbox: https://dc1demogwext.paylocity.com

   • Weblink API — Production: https://api.paylocity.com/

   • Weblink API — Sandbox: https://apisandbox.paylocity.com/

4. Enter the Client ID: this is the client_id you receive from Paylocity.

5. Enter the Client secret: this is the secret you receive from Paylocity.

Ref: https://prod.cdn.paylocity.com/developer/index.html

The Paylocity APIs provide information about employees only when their effective dates become active i.e., they fall within the current pay period. Our apps are limited by this as well and as and when Paylocity enhances their API’s, our apps will be able to leverage their new functionality.

Step 3: Map Paylocity Fields

Here are some common fields you can map from Paylocity

• employeeId

• employeeJobTitle

• employeeFirstName

• employeeLastName

• employeeHireDate

• employeeGender

• employeeSupervisor

• employeeSupervisorId

• employeeType

• employeeWorkEMailAddress

• employeeWorkPhone

• employeeCity

• employeeZip

More fields can be found in this link.