These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.

Webhook Events

The Webhook Event Object

Field nameValue typeDescription
event_typestringDescription of the event (e.g., payroll.submitted, or company.form.signed).
resource_typestringName of the parent resource of the described entity (e.g., Company, or AccountingFirm).
resource_uuidstringUnique identifier for the parent.
entity_typestringName of the entity that the event corresponds to.
entity_uuidstringUnique identifier for the entity.
timestampnumberTime at which this event was created. Measured in seconds since the Unix epoch.
referencesobjectObject containing related identifiers associated with the event.

List of Webhook Events

Subscription typeEvents
Bank Accountcreated
updated
deleted
Companyprovisioned
deprovisioned
partner_authorized
migrated
updated
onboarded
approved
needs_approval
CompanyBenefitcreated
updated
deleted
Contractorcreated
updated
onboarded
deactivated
deleted
Contractor Paymentcreated
cancelled
Employeecreated
updated
onboarded
marked_for_self_onboarding
terminated
rehired
deleted
HomeAddresscreated
updated
deleted
WorkAddresscreated
updated
deleted
EmployeeBenefitcreated
updated
deleted
EmployeeJobCompensationcreated
updated
deleted
External Payrollcreated
updated
deleted
Fast Ach Configactivated
deactivated
Formcreated
updated
signed
Generated Documentgenerated
failed
Locationcreated
updated
Notificationscreated
resolved
updated
PaySchedulecreated
updated
Payrollcreated
updated
calculated
submitted
processed
paid
reversed
partially_reversed
cancelled
Signatorycreated
updated
deleted
marked_for_invite