Error Event

This endpoint specifies what will be sent to your Error Event Webhook. Zeal POSTs a request containing error information to this endpoint URL. You can update the webhook URL you want Zeal to make the request to in the 'API' page of the Zeal dashboard.

Request Body

attribute

type

description

companyID

string

Zeal companyID of Employer

business_name

string

Business name of Employer

success

boolean

Success status of request

timestamp

string

Time that the error occured

employeeID

string

The Zeal Employee ID of that worker that this error is associated with

errors

array

List of errors that occurred

Show child attributes **message** type: string description: Error message

code
type: string
description: Zeal error code. You can find all Zeal error codes herehere

curl --location --request POST 'https://www.example.com/api/receiveErrorWebhook'