Employee Onboarding Event

POSTs a request upon completion of employee onboarding in the Zeal dashboard.

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

Request Body

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


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

Raw Content Example

  "test": true,
  "companyID": "083472985",
  "employeeID": "1234567890",
  "onboarded": true,
  "employment_status": "live",
  "first_name": "Erlich",
  "middle_initial": "A",
  "last_name": "Bachman",
  "dob": "1990-01-01",
  "start_date": "2023-05-01T20:46:27.961Z",
  "term_date": null,
  "ssn": "123456789",
  "phone_number": "+13456778934",
  "email": "[email protected]",
  "title": "Manager",
  "workLocationID": "123456789012345",
  "address": "1 Market St.",
  "address_line2": null,
  "city": "San Francisco",
  "state": "CA",
  "zip": "10000",
  "default_pay_schedule": "daily",
  "default_wage": 20,
  "default_ot_wage": 30,
  "default_dt_wage": 40,
  "autopilot": {
    "autopilot_on": false,
    "salary": null,
    "salary_firstDate": null
  "is_943": false,
  "is_scheduleH": false,
  "metadata": {},
  "business_name": "Test Company"