Skip to main content
Zeal POSTs to your Garnishment webhook whenever a garnishment order changes or withholding is applied/reversed on a check or contractor payment. Configure the URL on the Partner Dashboard API page. Use top-level event_type to distinguish events. Money fields are in dollars. Snapshot fields match the public garnishment API shape and always reflect post-event garnishment state. Optional fields are omitted when unset. Event-specific fields:
  • satisfied — includes satisfied_reason
  • applied — includes exactly one payment identity (employeeCheckID + check_date, or contractorPaymentID + payment_date), plus amount_withheld, cap_reason, and amount_before_cap
  • reversed — same payment identity + amount_withheld (no cap fields)

Event types

There is no separate capped event — cap audit lives on applied via cap_reason and amount_before_cap (including $0 starved applications). When a void reverses an apply that had satisfied the order, Zeal sends reversed with the updated snapshot (status often returns to active when the end date has not passed).

Returns

Doesn’t return anything but rather POSTs a request with garnishment details.

Raw Content Example

Created
Applied