Create a flow

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_typeentity_typeentity_uuidCategoryData dependenciesFlow description
run_payrolln/an/aPayrollOnboarded companyRun payrolls and manage historical payrolls
company_onboardingn/an/an/aFull company onboarding flow
add_addressesn/an/aCompany onboardingn/aManage company's work, mailing, and filing addresses
federal_tax_setupn/an/aCompany onboardingn/aReview and update company federal tax details
select_industryn/an/aCompany onboardingn/aSelect the company industry
add_bank_infon/an/aCompany onboardingn/aAdd bank info manually or via Plaid
verify_bank_infon/an/aCompany onboardingadd_bank_infoBank deposits verification
add_employeesn/an/aCompany onboardingadd_addressesManage all employee onboarding
state_setupn/an/aCompany onboardingadd_addresses, add_employeesReview 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_schedulen/an/aCompany onboardingn/aSet company's payroll schedule
sign_all_formsn/an/aCompany onboardingadd_employees, federal_tax_setup, state_setup, add_bank_info, payroll_scheduleAdd signatory and sign company documents
employee_form_signing'Employee'employee's UUIDEmployee onboardingadd_employeesFor employee to review and sign documents
employee_self_management'Employee'employee's UUIDEmployee onboardingadd_employeesFor 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.

Language
Authentication
Bearer
URL
Click Try It! to start a request and see the response here!