Paylocity
Connect Paylocity to Ploy so your employee directory and employment status flow into Ploy as an HR source of truth. Ploy reads from Paylocity and never writes to it.
This integration is in beta
The Paylocity integration is in beta. It was built from Paylocity's published API documentation and has not yet been run against a live Paylocity company. It works the same as any other integration, with one extra step.
The first page of the setup asks you to tick a consent checkbox. Ticking it lets Ploy record redacted error details when a call to Paylocity fails. Redacted means names, emails, IDs and secrets are removed before anything is stored, so what we keep is the shape of the error, such as the status code and which field Paylocity complained about. We use it only to fix the integration faster. You can connect only after ticking it.
What Ploy reads
Every employee in the connected company: name, work email, employee ID, job title, employee type and hire date.
Each employee's employment status: active, on leave, or terminated (including retired, deceased and transferred).
Ploy treats an employee as having access to Paylocity while they are employed, and records that access as ended when they are terminated. Employees on leave keep their access.
Ploy does not create, change, terminate or delete employees in Paylocity. Hires, leave and terminations are made in Paylocity as usual, and Ploy picks them up on its next scan, every six hours.
Before you start
You need a Paylocity API client for the main API gateway: a client ID and a client secret. Paylocity issues these through its developer program rather than in the Paylocity app.
Contact your Paylocity account team or the Paylocity developer program and ask for API credentials for an integration partner.
Ask for the client to be authorised to read Core HR employee demographics (the Employee Demographic API) for each Company ID you want Ploy to scan.
Note which environment the credentials are for. Production and testing (sandbox) credentials are different.
Each Paylocity Company ID is one payroll company. If your organisation uses a Company Set with several Company IDs, connect each Company ID separately. A Company Set ID does not work.
Connect Paylocity
In Ploy, open Integrations, find Paylocity and click Connect.
Tick the beta consent checkbox.
Choose the environment: Production for your live payroll data, or Testing if Paylocity gave you sandbox credentials.
Enter your Company ID, up to 9 letters or digits.
Paste the client ID and client secret.
Click Test connection. Ploy reads the first page of employees to check everything works.
Save. The first scan starts straight away.
Keeping the connection working
Paylocity expires client secrets at least once a year and emails your registered contact before it happens. When you rotate the secret, update it on the Paylocity connection in Ploy.
Troubleshooting
Paylocity rejected the client ID or client secret. Check both values, and check the environment matches the credentials.
Connected, but not authorised to read employees. The credentials are valid but the client is not authorised for employee demographics on that company. Ask Paylocity to grant it for that Company ID.
Paylocity could not find that company. Check the Company ID. It must be one company, not a Company Set.
An employee shows no email in Ploy. Ploy uses the work email held in Paylocity. Add a work email to the employee in Paylocity and it appears after the next scan.