New Hire Webhooks
Paylocity Webhooks support New Hires.
- Hire a new employee in HR & Payroll using one of the following processes:
- Log into HR & Payroll and manually hire an employee.
- Use Paylocity Onboarding to send Onboarding employees to Payroll.
- Hire an employee via Web Link imports.
- Use Paylocity Web Services API with a new hire 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 creating of Active Directory.
- Automate creating of employee in 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", |
| companyName | string | The employee's assigned company name. | "companyName": "Garner Group", |
| employeeAddressLine1 | string | The employee's address 1 line. | "employeeAddressLine1": "1060 W Addison St", |
| employeeAddressLine2 | string | The employee's address 2 line. | "employeeAddressLine2": "", |
| employeeBadgeClockNumber | string | The employee's badge or clock number. | "employeeBadgeClockNumber": "4321" |
| employeeCity | string | The employee's city. | "employeeCity": "Chicago", |
| 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", |
| employeeEEOClass | string | The employee's EEO class. | "employeeEEOClass": "Software Developer II", |
| employeeFirstName | string | The employee’s First Name. | "employeeFirstName": "Jane", |
| employeeGender | string | The employee's gender (Male, Female). | "employeeGender": "Female", |
| employeeHireDate | date-time | The employee's hire date formatted as YYYY-MM-DD. | "employeeHireDate": "2015-10-14T00:00:00Z", |
| employeeId | string | The employee's unique identifier. | "employeeId": "12345", |
| employeeJobTitle | string | The employee's job title. | "employeeJobTitle": "Software Developer", |
| employeeLastName | string | The employee’s Last Name. | "employeeLastName": "Doe", |
| employeeMaritalStatus | string | The employee's marital status (S-Single, M-Married). | "employeeMaritalStatus": "Single", |
| employeeMiddleInitial | string | The employee’s Middle Initial. | "employeeMiddleInitial": "R", |
| employeePayFrequency | string | The employee's pay frequency (A-Annual, B-Bi Weekly, D-Daily, M-Monthly, Q-Quarterly, S-Semi Monthly, W-Weekly). | "employeePayFrequency": "B", |
| employeePayType | string | The employee's pay type (Hourly or Salary) | "employeePayType": "Salary", |
| employeePosition | string | The employee's position. | "employeePosition": "?", |
| employeeState | string | The employee's two digit state code. | "employeeState": "IL", |
| employeeSupervisor | string | The supervisor's name. | "employeeSupervisor": "", |
| employeeSupervisorId | string | The employee Id of the supervisor. | "employeeSupervisorId": "15", |
| employeeType | string | The employee's type. | "employeeType": "Regular Full Time", |
| employeeWorkEMailAddress | string | The employee's Work Email address. | "employeeWorkEMailAddress": "[email protected]", |
| employeeWorkPhone | string | The employee’s work phone number. | "employeeWorkPhone": "(800) 555-1212", |
| employeeZip | string | The employee's zip code. | "employeeZip": "60613", |
| employeeTaxForm | string | The employee's tax form. | "employeeTaxForm": "W2" |
| } |
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 10 months ago