POSTs a request when a contractor payment is created, updated, or deleted in the Zeal dashboard.
This endpoint specifies what will be sent to your Contractor Payment Webhook. Zeal POSTs a request containing a Contractor Payment Object when it has been created, updated, or deleted 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
attribute | type | description |
|---|---|---|
test | boolean | Whether the Contractor Payment was created/updated/deleted in Test Mode |
type | string | The operation that was applied to this payment. |
Other Contractor Payment Object fields.
Returns
Doesn't return anything but rather POSTs a request with any changes in the Contractor Payment to your webhook URL.
Raw Content Example
{
"test": true,
"operation_type": "update",
"first_name": "Erlich",
"middle_name": null,
"last_name": "Bachman",
"status": "pending",
"approval_required": false,
"approved": false,
"contractorPaymentID": "06293648302820",
"contractorID": "1234567890",
"companyID": "083472985",
"pay_date": "2023-10-01",
"metadata": {},
"amount": 100.54,
"disbursement": {
"method": "direct_deposit",
"history": []
},
"timestamp": "2024-01-21T21:29:42Z"
}