Payroll Events
When subscribed to the Payroll
webhooks you will receive the following events:
event_type | description |
---|---|
payroll.created | Payroll has been created |
payroll.updated | Payroll has been updated |
payroll.calculated | Payroll has been calculated |
payroll.submitted | Payroll has been submitted and the request will be received and processed by Gusto. |
payroll.processed | Payroll has been validated and has finished processing. The company will be debited on the expected debit date. |
payroll.paid** | Payroll credits have been generated and payments will be made. |
payroll.reversed | Payroll debits have been fully reversed, and the payroll will be cancelled. |
payroll.partially_reversed | Payroll debits have been partially reversed. |
payroll.cancelled | Payroll has been cancelled. |
payroll.processing_failed | Payroll has failed to process due to an issue with an async payroll calculation or payroll submission. When payroll processing fails, our Payroll API will also return errors as described here. |
** Event is not triggered in the demo environment.
Example payload
{
"uuid": "e5540567-a6ee-4ce8-bf3e-a12c563db54c",
"event_type": "payroll.updated",
"resource_type": "Company",
"resource_uuid": "5df911a0-e8e9-412d-8aaf-a46ad193dd96",
"entity_type": "Payroll",
"entity_uuid": "c02f2c32-34f7-4128-9145-7d49f0c3f355",
"timestamp": 1671058841
}
Updated 18 days ago