Employee Check Event

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


Request Body

attributetypedescription
testbooleanWhether the employee check was created/updated/deleted in Test Mode
typestringThe operation that was applied to this employee check.
create
update
delete
business_namestringBusiness Name of Employer

Other Employee Check Object fields


Returns

Doesn't return anything but rather POSTs a request with the any changes in the Employee Check Object to your webhook URL


Raw Content Example

{
  "test": false,
  "type": "create",
  "companyID": "1b5n28nrideucd24",
  "business_name": "Test Company",
  "employeeCheckID": "9827465739",
  "employerCheckID": null,
  "employeeID": "1234567890",
  "reportingPeriodID": "0982349584387523234",
  "status": "pending",
  "approval_required": false,
  "approved": false,
  "first_name": "erlich",
  "middle_initial": null,
  "last_name": "bachman",
  "check_date": "2020-01-07T00:00:00Z",
  "disbursement": {
    "method": "direct_deposit"
  },
  "gross_pay": 40,
  "net_pay": null,
  "taxes": null,
  "total_employer_taxes": null,
  "total_employee_taxes": null,
  "shifts": [
    {
      "employeeID": "1234567890",
      "shiftID": "123456789",
      "first_name": "erlich",
      "last_name": "bachman",
      "metadata": {},
      "time": "2019-12-12T10:00:00",
      "hourly": {
        "hours": 2,
        "wage": 20
      }
    }
  ]
}