Payroll Processed Webhooks
Paylocity Webhooks support Payroll Processed.
Payroll Processed Webhooks send when a company processes payroll. Companies typically process payroll two days prior to check date, so the Webhook typically sends two days prior to the check date. The JavaScript Object Notation (JSON) content below identifies the values sent in the Webhooks notification.
- Payroll processed through HR & Payroll.
- Web Link automatically detects the payroll process is complete.
- Webhook sent to the user-provided HTTPS URL on the process date.
- The user can consume the information in any way they see fit.
Examples
- Call the PayStatements Pay Statements endpoint to get the processed payroll details.
- Update internal systems to take additional actions after payroll has completed.
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", |
| processId | string | The date of the check appended with the 2 digit runID | "processId": "2022012701", |
| checkDate | date-time | The date of the check formatted as YYYY-MM-DD. | "checkDate": "2022-01-27", |
| runId | string | The sequential number of payruns for the specified check date. | "runId": "1", |
| processDate | date-time | The date of the payrun event formatted as YYYY-MM-DD HH:MM:SS.ss | "processDate": "2022-01-25T10:31:05.90", |
| status | string | The final status of the payrun. | "status": "Processed" |
| } |
Additional Information
- The Webhook sends on process date, not on check date. The process date is typically two days prior to check date, however, companies can process payroll on any date up to and including the check date.
- The Employee ID (EEID) is not exposed on the Webhook, as there could be 0-200,000 EEIDs in a given database. The best practice is to store the Check Date provided by the Webhook for future PayStatement Details Endpoint Calls as the Check Date is a required URI Component and the EEIDs can be populated by Get all employees API.
- 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 8 months ago