Report Status Change Event

This endpoint specifies what will be sent to the Report Status Change Event Webhook. Zeal POSTs an object with corresponding job information whenever a report is created or its status is updated.


Request Body

attribute

type

description

jobType

string

Corresponding job type -
parameters could be PreviewCheckDate
PreviewChecks or Reports

reportType

string

The type of report the job is for

companyID

string

Zeal companyID of Employer

status

string

Status of job

jobID

string

Corresponding job ID


Returns

Doesn't return anything, rather POSTs relevant job_type & corresponding data to the webhook URL


Raw Content Example

{
  "jobID": "b371b7f6-3187-40e1-9065-1e41d25065c4",
  "status": "in-progress",
  "reportType": "worker_summary",
  "companyID": "be379eb1635640c7b132caa2665129da",
  "business_name": "Test Company",
  "createdAt": "2022-08-30T19:12:02.642Z",
  "updatedAt": "2022-08-30T19:12:02.642Z",
  "test": false
}