Termination Webhooks
Paylocity Webhooks support Terminations.
- 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.
- Web Link automatically detects the employment status change.
- Webhook sent to the user-provided HTTPS URL.
- The user can consume the information in any way they see fit.
Examples
- Create tickets for internal systems.
- Automate disabling of Active Directory.
- Automate disabling of other systems.
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 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", |
| 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", |
| } |
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