Generate a link to access a pre-built workflow in Gusto whitelabel UI. For security, all generated flows will expire within 1 hour of inactivity. Additionally, flows will be deactivated 24 hours from creation time. We currently support the following flow types
You can test them out via our demo flows
| flow_type | entity_type | entity_uuid | Category | Data dependencies | Flow description |
|---|---|---|---|---|---|
| run_payroll | n/a | n/a | Payroll | Onboarded company | Run payrolls and manage historical payrolls |
| company_onboarding | n/a | n/a | n/a | Full company onboarding flow | |
| add_addresses | n/a | n/a | Company onboarding | n/a | Manage company's work, mailing, and filing addresses |
| federal_tax_setup | n/a | n/a | Company onboarding | n/a | Review and update company federal tax details |
| select_industry | n/a | n/a | Company onboarding | n/a | Select the company industry |
| add_bank_info | n/a | n/a | Company onboarding | n/a | Add bank info manually or via Plaid |
| verify_bank_info | n/a | n/a | Company onboarding | add_bank_info | Bank deposits verification |
| add_employees | n/a | n/a | Company onboarding | add_addresses | Manage all employee onboarding |
| state_setup | n/a | n/a | Company onboarding | add_addresses, add_employees | Review and update company state taxes. At this time, this only works for pre-onboarded companies - attempting to generate a state_setup flow with a post-onboarded company will return a 422 error. |
| payroll_schedule | n/a | n/a | Company onboarding | n/a | Set company's payroll schedule |
| sign_all_forms | n/a | n/a | Company onboarding | add_employees, federal_tax_setup, state_setup, add_bank_info, payroll_schedule | Add signatory and sign company documents |
| employee_form_signing | 'Employee' | employee's UUID | Employee onboarding | add_employees | For employee to review and sign documents |
| employee_self_management | 'Employee' | employee's UUID | Employee onboarding | add_employees | For employee to manage their own onboarding |
Custom flows
In addition to the above, you can also mix and match flow_types in the same category to create custom flows suitable for your needs. For instance, to create a custom onboarding flow that only includes add_addresses, add_employees, and sign_all_forms steps, simply stitch those flow_types together into a comma delimitted string:
{
flow_type: "add_addresses,add_employees,sign_all_forms"
}
You can also rearrange the flow_types in any order you see fit. However, please be mindful of data dependencies in each step to achieve the best user experience.