Skip to main content

EmployeeOnboarding

Flows and blocks for onboarding employees.

import { EmployeeOnboarding } from '@gusto/embedded-react-sdk'

🚂 Workflows​

ComponentDescription
OnboardingExecutionFlowGuided flow to onboard an employee.
OnboardingFlowGuided flow to onboard multiple employees, one at a time.
SelfOnboardingFlowGuided flow for employees to complete their own onboarding.

🧩 Blocks​

ComponentDescription
CompensationOnboarding step for collecting an employee's role and compensation details.
DeductionsOnboarding step for collecting an employee's post-tax deductions and court-ordered garnishments.
DocumentListLists the employee's documents pending signature.
DocumentSignerOnboarding step for signing employee documents.
EditCompensationRenders a form for creating or editing one of an employee's jobs together with its compensation.
EmployeeDocumentsOnboarding step for selecting which documents the employee must complete.
EmployeeListRenders a paginated list of a company's employees with per-row onboarding actions (edit, delete, review, cancel self-onboarding) and an "Add employee" entry point.
EmploymentEligibilityCaptures the employee's I-9 employment eligibility (Section 1) before signing.
FederalTaxesOnboarding step for collecting an employee's federal tax (W-4) withholdings — filing status, multiple-jobs flag, dependents, other income, deductions, and extra withholding.
I9SignatureFormPresents the employee's I-9 form for review and signature.
JobsListLists an employee's jobs alongside their compensation details, with controls to add, edit, or remove a job.
LandingLanding page for the employee self-onboarding flow. Displays a welcome message and the list of onboarding steps the employee needs to complete.
OnboardingSummaryDisplays a summary of an employee's onboarding status, listing completed and outstanding steps. Rendered as a standalone step inside OnboardingFlow.
PaymentMethodOnboarding step for setting up an employee's payment method.
ProfileOnboarding step for collecting an employee's basic profile and addresses.
SignatureFormPresents a single employee document for review and signature.
StateTaxesOnboarding step that collects an employee's per-state tax withholding answers. The set of fields is driven by the API response for each state on record.