Contractor Event

POSTs a request when a contractor is created, onboarded, or updated in the Zeal dashboard.

This endpoint specifies what will be sent to your Contractor Webhook. Zeal POSTs a request containing a Contractor Object when it has been created, onboarded, or updated in the dashboard. You can update and test the webhook URL you want Zeal to hit on the 'API' Page of the Zeal Dashboard.


Request Body

attributetypedescription
testbooleanWhether the contractor was updated or deleted in Test Mode
typestringThe operation that was applied to this contract
create
onboard
update
delete

Other Contractor Object fields.


Returns

Doesn't return anything but rather POSTs the updated or deleted Contractor Object to the webhook URL.


Raw Content Example

{
  "test": true,
  "operation_type": "update",
  "contractorID": "1234567890",
  "companyID": "083472985",
  "onboarded": true,
  "email": "[email protected]",
  "working_state": "CA",
  "first_name": "Erlich",
  "middle_name": null,
  "last_name": "Bachman",
  "type": "individual",
  "ssn": "375289876",
  "business_name": null,
  "ein": null,
  "address": "1 Market St.",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105"
}