Bank Account Events
When subscribed to the BankAccount
webhooks you will receive the following events:
event_type | description | references |
---|---|---|
company.bank_account.created | Company bank account has been created | {"company_uuid": ""} |
company.bank_account.verified | Company bank account has been verified | {"company_uuid": ""} |
company.bank_account.updated | Company bank account has been updated | {"company_uuid": ""} |
company.bank_account.deleted | Company bank account has been deleted | {"company_uuid": ""} |
contractor.bank_account.created | Contractor bank account has been created | {"contractor_uuid": ""} |
contractor.bank_account.updated | Contractor bank account has been updated | {"contractor_uuid": ""} |
contractor.bank_account.deleted | Contractor bank account has been deleted | {"contractor_uuid": ""} |
employee.bank_account.created | Employee bank account has been created | {"employee_uuid": ""} |
employee.bank_account.updated | Employee bank account has been updated | {"employee_uuid": ""} |
employee.bank_account.deleted | Employee bank account has been deleted | {"employee_uuid": ""} |
Bank account webhooks contain references
that will have the additional UUIDs to call the Gusto API to retrieve the entire entity. The example below contains references because an employee UUID is required to retrieve the bank account from the API /v1/employees/{employee_id}/payment_method
Example payload
{
"uuid": "dd929277-ad89-4e8b-bb8b-cfd229b05b9a",
"timestamp": 1673976552,
"event_type": "employee.bank_account.created",
"references": {
"employee_uuid": "c41833cb-9c89-4f34-9fdc-13c6e603d38e"
},
"entity_type": "BankAccount",
"entity_uuid": "1447e450-d83b-4118-8e17-72d1c470351c",
"resource_type": "Company",
"resource_uuid": "85574607-c15a-42fe-8f53-1bb1b58c8055"
}
Updated 5 months ago