Use this table to see all the current notification types with a brief description on what the messaging will include, the contents of its resource array, what triggers it, whether it is actionable or not, whether it is payroll blocking, and whether it expires.Documentation Index
Fetch the complete documentation index at: https://gusto-preview.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
| Category | Title | Message | Resource entity types | Trigger | Actionable | Action Item | Payroll Blocking | Resolves? | Expires? | Template Variables |
|---|---|---|---|---|---|---|---|---|---|---|
| recovery_case.connect_new_bank | Connect a new bank account to unblock payroll | We weren’t able to debit funds for the %{date} %{event}. To pay the team on time, connect a new bank account as soon as possible. | entity_type: “RecoveryCase” | Due to an R02 bank error, Gusto was unable to debit funds for a past payroll or contractor payment. Please note that payroll will be blocked until the amount has been recovered. | yes | Connect a new company bank account and initiate a new redebit via API call or via company_recovery_cases flow | yes | Yes, it resolves after a redebit has been initiated on the recovery case | no | {date}, {event} |
| recovery_case.insufficient_funds | Add sufficient funds to unblock payroll | We weren’t able to debit funds for the %{date} %{event}. To pay the team on time, check that the associated bank account has sufficient funds as soon as possible. | entity_type: “RecoveryCase” | Due to an R01 bank error, Gusto was unable to debit funds for a past payroll or contractor payment. Please note that payroll will be blocked until the amount has been recovered. | yes | Add sufficient funds to the company’s bank account and initiate a new redebit via API call or via company_recovery_cases flow | yes | Yes, it resolves after a redebit has been initiated on the recovery case | no | {date}, {event} |
| recovery_case.unfreeze_bank_account | Unfreeze bank account to unblock payroll | We weren’t able to debit funds for the %{date} %{event}. To pay the team on time, unfreeze the associated bank account as soon as possible. | entity_type: “RecoveryCase” | Due to an R16 bank error, Gusto was unable to debit funds for a past payroll or contractor payment. Please note that payroll will be blocked until the amount has been recovered. | yes | Unfreeze the company bank account and initiate a new redebit via API call or via company_recovery_cases flow | yes | Yes, it resolves after a redebit has been initiated on the recovery case | no | {date}, {event} |
| recovery_case.verify_bank_account | Verify bank account details to unblock payroll | We weren’t able to debit funds for the %{date} %{event}. To pay the team on time, verify the associated bank account as soon as possible. | entity_type: “RecoveryCase” | Due to a bank error, Gusto was unable to debit funds for a past payroll or contractor payment. Please note that payroll will be blocked until the amount has been recovered. | yes | Verify company bank account details and initiate a new redebit via API call or via company_recovery_cases flow. Contact support for further assistance | yes | Yes, it resolves after a redebit has been initiated on the recovery case | no | {date}, {event} |
| recovery_case.redebit_successful | Debit for %{company_name} was successful | We wanted to let you know that our attempt to debit ${company_name}‘s bank account for your %{payment_check_date} payday was successful. Your ability to process payroll has been reinstated. \n \nPlease ensure that your bank account has sufficient balance for future Paydays to ensure that your employees continue getting paid in a timely manner. In addition, if bank errors continue to be an issue your service may be interrupted. If you foresee a bank error in the future, please contact us so we may assist you with this matter. | entity_type: “RecoveryCase” | Redebit was successful | no | N/A | no | no | no | {company_name}, {payment_check_date} |