Skip to main content

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.

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.
CategoryTitleMessageResource entity typesTriggerActionableAction ItemPayroll BlockingResolves?Expires?Template Variables
auto_payroll.disabledAutomatic payroll has been disabledDue to a recent account change, automatic payroll has been disabled. Run the next scheduled payroll manually to make sure the team is paid on time.noneSee section ‘actions that will disable autopilot’ https://support.gusto.com/article/999755421000000/Use-and-manage-Payroll-on-AutoPilotyesRun the next scheduled payroll manually. To re-enroll in automatic payroll, fix the underlying issue and then use the update pay schedule API to re-enroll in automatic payroll.nonoyes - after 7 daysNone
auto_payroll.excluded_employeesAutomatic payroll excluded some employees for %{payment_check_date} payrollUnfortunately, since we’re missing state tax details for %{states_to_sentence}, automatic payroll excluded the following employees from %{payment_check_date} payroll: %{employees}. Please provide missing tax details to include the employees in the next payroll, and run an off-cycle payroll if they still need to be paid for this pay period.entity_type: “Employee”Missing state tax detailsyesUpdate missing state tax details, and run an off-cycle payroll to pay the excluded employees.nonoyes - after 7 days{payment_check_date}, {states_to_sentence}, {employees}
auto_payroll.failedAutomatic payroll failed for %{payment_check_date} payrollUnfortunately, automatic payroll failed for %{payment_check_date} payroll. Please run payroll manually to make sure the team is paid on time.entity_type: “Payroll”Either the company is not allowed to run payroll, or the payroll itself failed.yesRun the payroll manually.nonoyes - after 7 days){payment_check_date}