Employee Onboarding Event

This endpoint specifies what will be sent to your Onboarding Webhook. Zeal POSTs a request containing an The Employee Object once they have completed the onboarding process. You can update the webhook URL you want Zeal to hit in the 'API' page of the Zeal Dashboard.

attribute

type

description

test

boolean

Whether the worker was "onboarded" in Test Mode

companyID

string

Zeal companyID of Employer

business_name

string

Business Name of Employer

Other The Employee Object fields

Returns

Doesn't return anything

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