Employee Onboarding Event

This endpoint specifies what will be sent to your Onboarding Webhook. Zeal POSTs a request containing an The Employee Object once they have completed the onboarding process. You can update the webhook URL you want Zeal to hit in the 'API' page of the Zeal Dashboard.


Request Body

attributetypedescription
testbooleanWhether the worker was "onboarded" in Test Mode
companyIDstringZeal companyID of Employer
business_namestringBusiness Name of Employer
The Employee ObjectstringOther employee object fields

Returns

Doesn't return anything, rather POSTs The Employee Object & data to the webhook URL


Raw Content Example

{
  "test": false,
  "companyID": "083472985",
  "business_name": "Test Company",
  "onboarded": true,
  "employeeID": "1234567890",
  "first_name": "Fake",
  "last_name": "Employee",
  "ssn": "123456789",
  "phone_number": "+13456778934",
  "email": "[email protected]",
  "title": "Manager",
  "default_pay_schedule": "daily",
  "default_wage": 20,
  "default_ot_wage": 30,
  "default_dt_wage": 40,
  "address": "1 Market St.",
  "city": "San Francisco",
  "state": "CA",
  "zip": "10000"
}