Employer Check Created Event

This endpoint specifies what will be sent to your 'Employer Check Created' Webhook. Zeal POSTs a request containing an Employer Check Object created from pending checks, at 3 PM PST. You can update the webhook URL you want Zeal to hit in the 'API' Page of the Zeal Dashboard.

Request Body

attribute

type

description

test

boolean

Whether the employee check was created in Test Mode

companyID

string

Zeal companyID of Employer

business_name

string

Business Name of Employer

employerCheckID

string

Employer Check ID

status

string

Will hold the following values:
pre-processed

reporting_periods

array

List of reporting periods contained in this employer check.

Show child attributes **reportingPeriodID** type: string description: Reporting Period ID

start
type: datetime
description: Start time and date of reporting period

end
type: datetime
required: End time and date of reporting period

totals

object

Totals for this employer check stored in an object

Show child attributes **gross_pay** type: number description: Gross pay for employee (total pay before taxes)

employee_checks

array

List of all employee checks. Each object contains information regarding how each employee is paid for this payroll run (i.e. everything found on a paystub and more). See Employee Check Object for all attributes.

Returns

Doesn't return anything

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