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. |
List of Webhook Events
Subscription type | Events |
---|---|
Bank Account | created updated deleted |
Company | provisioned deprovisioned partner_authorized migrated updated onboarded approved needs_approval |
CompanyBenefit | created updated deleted |
Contractor | created updated onboarded deactivated deleted |
Contractor Payment | created cancelled |
Employee | created updated onboarded marked_for_self_onboarding terminated rehired deleted |
HomeAddress | created updated deleted |
WorkAddress | created updated deleted |
EmployeeBenefit | created updated deleted |
EmployeeJobCompensation | created updated deleted |
External Payroll | created updated deleted |
Fast Ach Config | activated deactivated |
Form | created updated signed |
Generated Document | generated failed |
Location | created updated |
Notifications | created resolved updated |
PaySchedule | created updated |
Payroll | created updated calculated submitted processed paid reversed partially_reversed cancelled |
Signatory | created updated deleted marked_for_invite |
Updated 18 days ago