Employee Change Webhooks
Paylocity Webhooks support Employee Change.
- 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.
- Web Link automatically detects the employee change.
- Webhook sent to the user-provided HTTPS URL.
- The user can consume the information in any way they see fit.
Examples
- Trigger an API GET request to obtain the employee fields from HR & Payroll.
- Sync changes across the company's systems.
- The Webhook distributes when any of the fields from the list below change.
- Changes poll every minute, which might result in multiple notifications if several fields from the list change over one minute.
Since the Webhooks do not contain all data elements, after receiving a Webhook notification, Paylocity recommends programming the created application to make a call to the API to receive all relevant data for the destination system rather than relying only on the data in a Webhook notification to make each necessary update.
The following fields trigger the Employee Change Webhook:
Fields | ||
---|---|---|
LastName | PersonalEmail | Phone1 |
FirstName | EmpStatus | Phone1Ext |
MiddleName | HireDate | Phone2 |
Ssn | TermDate | Phone2Ext |
BirthDate | TermReason | Phone3 |
Sex | RehireDate | Phone3Ext |
Ethnicity | CostCenter1 | EmailAddress |
MaritalStatus | CostCenter2 | PrimaryPayRate |
AddressLine1 | CostCenter3 | BaseRate |
AddressLine2 | EmpType | DefaultHours |
City | Title | PayFrequency |
State | EeoClass | PayType |
Zip | PayGroup | PrimaryPayRateEffectiveDate |
PersonalMobilePhone | Salary |
The JSON message sent consists of companyid and employeeid.
The message header includes the following:
Key | Value |
---|---|
connection | close |
expect | 100-continue |
content-length | <sum of characters/rows on the json body> |
host | <specific to connection> |
content-type | application/json |
Property | Type | Description | Sample |
---|---|---|---|
{ | |||
companyId | string | The employee's assigned company id. | "companyId": "C01", |
employeeId | string | The employee's unique identifier. | "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.
Updated 11 months ago