This endpoint specifies what will be sent to your Employee Requirement Webhook. Zeal POSTs a request containing the Employee Requirement object. 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 Requirement was created in Test Mode
employeeRequirementID	string	ID of the employee requirement
companyID	string	ID of company
employeeID	string	ID of employee
date	string	Date when the requirement was created
formTemplateID	string	ID of the form template
workLocationID	string	ID of the work location
jurisdiction	string	Jurisdiction of the requirement
type	string	Type of requirement
status	string	Status of requirement: `OPEN`, `CLOSED`

Returns

Doesn't return anything but rather POSTs a request with the Employee Requirement object to your webhook URL.

Raw Content Example

{
  "test": true,
  "employeeRequirementID": "a60efd68-e6ab-4db1-b4e6-fd7ee2888b3a",
  "type": "FORM",
  "status": "OPEN",
  "jurisdiction": "US",
  "formTemplateID": "form-aca0c649-ccd5-4c14-9337-f8d22d1fadc1",
  "employeeID": "66fec7a8e62b170d86ce23d3",
  "companyID": "23d5656d3511415b8354faf59f3486db",
  "date": "2024-12-11T20:04:20.219Z",
  "timestamp": "2024-12-11T20:04:20.219Z"
}