GuidesAPI ReferenceChangelog

Employee Change Webhooks

Triggers for Employee Change Webhooks Notification

Change employee data using one of the following processes:

  • Log into HR & Payroll and make changes to employee data, such as modifying address fields, cost center, or status, or rehiring an employee.
  • Modify employee data via Web Link imports.
  • Use Paylocity Web Services API with an update employee request.

The following fields trigger the Employee Change Webhook:

Fields
LastNamePersonalEmailPhone1
FirstNameEmpStatusPhone1Ext
MiddleNameHireDatePhone2
SsnTermDatePhone2Ext
BirthDateTermReasonPhone3
SexRehireDatePhone3Ext
EthnicityCostCenter1EmailAddress
MaritalStatusCostCenter2PrimaryPayRate
AddressLine1CostCenter3BaseRate
AddressLine2EmpTypeDefaultHours
CityTitlePayFrequency
StateEeoClassPayType
ZipPayGroupPrimaryPayRateEffectiveDate
PersonalMobilePhoneSalary

The JSON message sent consists of companyid and employeeid.

Common use cases for these Webhooks

  1. Sync change in employee data / metadata across company systems
  2. Triggering an API GET request to re-poll all employee fields from HR & Payroll

πŸ“˜

Implementation Notes

  • The Webhook notification triggers when any of the fields from the list above change.
  • Changes poll every minute, which might result in multiple notifications if several fields from the list change over one minute.
  • Don't rely on the Webhooks notification to provide all updated information fields, instead make a call to the relevant APIs to get the latest details; in some cases, especially related to employee information, a single user triggered change may result in additional automated system changes to that data object. Calls can be made using the company and ID values provided from the notification.

Message Syntax

The message header includes the following:

KeyValue
connectionclose
expect100-continue
content-length<sum of characters/rows on the json body>
host<specific to connection>
content-typeapplication/json
PropertyTypeDescriptionSample
{
companyIdstringThe employee's assigned company id."companyId": "C01",
employeeIdstringThe employee's unique identifier."employeeId": "12345",
}

Code Example

{
  "companyId": "C01",
  "employeeId": "12345"
}

πŸ“˜

Additional Information

Paylocity reserves the right to impose rate limits on the number of calls made to Paylocity APIs. If rate limits are present, a 429 response code, Too Many Requests, returns from the API.

Copyright Β© 2024 Paylocity. All Rights Reserved. Privacy Center | Terms and Conditions | Accessibility