Employee Event

This endpoint specifies what will be sent to your Employee Webhook. Zeal POSTs a request containing an The Employee Object when it has been updated in the dashboard. You can update and test the webhook URL you want Zeal to hit on the 'API' Page of the Zeal Dashboard.


Request Body

attributetypedescription
testbooleanWhether the employee was updated or deleted in Test Mode
typestringThe operation that was applied to this employee
update
delete

Other The Employee Object fields


Returns

Doesn't return anything but rather POSTs the updated or deleted Employee Object to the webhook URL


Raw Content Example

{
  "type": "update",
  "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": "2022-01-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"
}