Webhook Events

The Webhook Event Object

Field name	Value type	Description
event_type	string	Description of the event (e.g., payroll.submitted, or company.form.signed).
resource_type	string	Name of the parent resource of the described entity (e.g., Company, or AccountingFirm).
resource_uuid	string	Unique identifier for the parent.
entity_type	string	Name of the entity that the event corresponds to.
entity_uuid	string	Unique identifier for the entity.
timestamp	number	Time at which this event was created. Measured in seconds since the Unix epoch.
references	object	Object containing related identifiers associated with the event.

Subscription type	Events
BankAccount	created updated deleted
Company	provisioned deprovisioned partner_authorized migrated updated onboarded approved needs_approval marked_as_high_risk_business marked_as_marijuana_business suspended unsuspended
CompanyBenefit	created updated deleted
Contractor	created updated onboarded deactivated reactivated deleted
ContractorPayment	created cancelled
ContractorPaymentGroup	created cancelled
Document	created updated signed
Employee	created updated onboarded marked_for_self_onboarding terminated rehired deleted invited_to_partner_portal
HomeAddress	created updated deleted
WorkAddress	created updated deleted
EmployeeBenefit	created updated deleted
EmployeeJobCompensation	created updated deleted
ExternalPayroll	created updated deleted
FastAchConfig	activated deactivated
Form	created updated signed
GeneratedDocument	generated failed
Location	created updated
Notifications	created resolved updated
Payroll	created updated calculated submitted processed paid reversed partially_reversed cancelled processing_failed
PaySchedule	created updated
Signatory	created updated deleted marked_for_invite