Triggers for Termination Webhooks Notification
Terminate an employee using one of the following processes:
- Log into HR & Payroll and terminate the employee.
- Terminate an employee via Web Link imports.
- Use Paylocity Web Services API with an update employee request.
Common use cases for these Webhooks
- Creating action queues for internal systems
- Automate disabling of active directory users
- Automate disabling user accounts in other systems
Implementation Recommendation
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:
| 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": "GC3456789", |
| employeeCostCenter1 | string | The employee's first assigned cost center formatted as (Code - Description). | "employeeCostCenter1": "11 - Software Development", |
| employeeCostCenter2 | string | The employee's second assigned cost center formatted as (Code - Description). | "employeeCostCenter2": "22 - Director 2", |
| employeeCostCenter3 | string | The employee's third assigned cost center formatted as (Code - Description). | "employeeCostCenter3": "33 - Team 3", |
| employeeFirstName | string | The employee’s First Name. | "employeeFirstName": "Jane", |
| employeeId | string | The employee's unique identifier. | "employeeId": "12345", |
| employeeLastName | string | The employee’s Last Name. | "employeeLastName": "Doe", |
| employeeMiddleInitial | string | The employee’s Middle Initial. | "employeeMiddleInitial": "R", |
| employeeWorkEMailAddress | string | The employee's Work Email address. | "employeeWorkEMailAddress": "[email protected]", |
| employeeTerminationDate | date-time | The date of the employee's termination event formatted as YYYY-MM-DD. | "employeeTerminationDate": "2015-09-30T00:00:00Z", |
| } |
Code Example
{
"companyId":"GC3456789",
"employeeId":"12345",
"employeeFirstName":"Jane",
"employeeMiddleInitial":"R",
"employeeLastName":"Doe",
"employeeWorkEMailAddress":"[email protected]",
"employeeCostCenter1":"11 - Software Development",
"employeeCostCenter2":"22 - Director 2",
"employeeCostCenter3":"33 - Team 3",
"employeeTerminationDate":"2015-09-30T00:00:00Z"
}
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.