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 on the 'API' Page of the Zeal Dashboard.

Request Body

attribute	type	description
test	boolean	Whether the employee check was created/updated/deleted in Test Mode
type	string	The operation that was applied to this employee check. `create` `update` `delete`
business_name	string	Business Name of Employer

Other Employee Check Object fields.

Returns

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

Raw Content Example

{
  "test": true,
  "type": "create",
  "companyID": "1b5n28nrideucd24",
  "business_name": "Test Company",
  "employeeCheckID": "9827465739",
  "employerCheckID": null,
  "employeeID": "1234567890",
  "reportingPeriodID": "0982349584387523234",
  "status": "pending",
  "is_salary": false,
  "approval_required": false,
  "approved": false,
  "first_name": "Erlich",
  "middle_initial": null,
  "last_name": "Bachman",
  "check_date": "2023-12-07T00:00:00Z",
  "metadata": {},
  "disbursement": {
    "method": "direct_deposit",
    "history": []
  },
  "gross_pay": 40,
  "net_pay": null,
  "taxes": [],
  "total_employer_taxes": null,
  "total_employee_taxes": null,
  "totals": {
    "gross_earnings": null,
    "gross_pay": null,
    "net_pay": null,
    "employer_taxes": null,
    "employee_taxes": null,
    "employee_deductions": null,
    "employee_garnishments": null,
    "employer_deductions": null,
    "company_debit": null,
    "company_cash_requirement": null
  },
  "shifts": [
    {
      "employeeID": "1234567890",
      "shiftID": "123456789",
      "employeeCheckID": "9827465739",
      "status": "pending",
      "first_name": "erlich",
      "last_name": "bachman",
      "metadata": {},
      "wcc_code": null,
      "workLocationID": 34567890,
      "time": "2023-11-12T10:00:00",
      "hourly": {
        "hours": 2,
        "wage": 20
      }
    }
  ],
  "deductions": [],
  "timestamp": "2024-01-21T21:29:42Z"
}