Contractor Event

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, updated or deleted. You can update and test the webhook URL you want Zeal to hit in 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
created
onboarded
update
delete

Other Contractor Object fields


Returns

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


Raw Content Example

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