embedded-react-sdk/docs/reference/events.md at main · Gusto/embedded-react-sdk

title	Events
description	Event types fired when users take actions or complete steps in SDK components. Pass a function matching `OnEventType` as the `onEvent` prop. See the Event handling guide for usage patterns.
sidebar_position	9
generated_by	typedoc
custom_edit_url

Event types fired when users take actions or complete steps in SDK components. Pass a function matching OnEventType as the onEvent prop. See the Event handling guide for usage patterns.

componentEvents

const componentEvents: object

Catalog of every event key that an SDK component can emit through onEvent.

Remarks

Components surface user actions and lifecycle transitions to the integrating application through an onEvent(type, data) callback. The type argument is always one of the string values in this object. Use this map to compare against the incoming type rather than hard-coding strings.

All domain-specific event groups are spread into this object alongside a few cross-cutting keys: ERROR, CANCEL, and BREADCRUMB_NAVIGATE.

Example

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

<EmployeeOnboarding
  companyId={companyId}
  onEvent={(type, data) => {
    if (type === componentEvents.EMPLOYEE_ONBOARDING_DONE) {
      navigate('/employees')
    }
  }}
/>

Type Declaration

Name	Type
`BREADCRUMB_NAVIGATE`	`"breadcrumb/navigate"`
`CANCEL`	`"CANCEL"`
`COMPANY_ASSIGN_SIGNATORY_DONE`	`"company/signatory/assignSignatory/done"`
`COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED`	`"company/signatory/assignSignatory/modeUpdated"`
`COMPANY_BANK_ACCOUNT_CANCEL`	`"company/bankAccount/cancel"`
`COMPANY_BANK_ACCOUNT_CHANGE`	`"company/bankAccount/change"`
`COMPANY_BANK_ACCOUNT_CREATED`	`"company/bankAccount/created"`
`COMPANY_BANK_ACCOUNT_DONE`	`"company/bankAccount/done"`
`COMPANY_BANK_ACCOUNT_VERIFIED`	`"company/bankAccount/verified"`
`COMPANY_BANK_ACCOUNT_VERIFY`	`"company/bankAccount/verify"`
`COMPANY_CREATE_SIGNATORY_DONE`	`"company/signatory/createSignatory/done"`
`COMPANY_FEDERAL_TAXES_DONE`	`"company/federalTaxes/done"`
`COMPANY_FEDERAL_TAXES_UPDATED`	`"company/federalTaxes/updated"`
`COMPANY_FORM_EDIT_SIGNATORY`	`"company/forms/editSignatory"`
`COMPANY_FORMS_DONE`	`"company/forms/done"`
`COMPANY_INDUSTRY`	`"company/industry"`
`COMPANY_INDUSTRY_SELECTED`	`"company/industry/selected"`
`COMPANY_INVITE_SIGNATORY_DONE`	`"company/signatory/inviteSignatory/done"`
`COMPANY_LOCATION_CREATE`	`"company/location/add"`
`COMPANY_LOCATION_CREATED`	`"company/location/add/done"`
`COMPANY_LOCATION_DONE`	`"company/location/done"`
`COMPANY_LOCATION_EDIT`	`"company/location/edit"`
`COMPANY_LOCATION_UPDATED`	`"company/location/edit/done"`
`COMPANY_OVERVIEW_CONTINUE`	`"company/overview/continue"`
`COMPANY_OVERVIEW_DONE`	`"company/overview/done"`
`COMPANY_SIGN_FORM`	`"company/forms/sign/signForm"`
`COMPANY_SIGN_FORM_BACK`	`"company/forms/sign/back"`
`COMPANY_SIGN_FORM_DONE`	`"company/forms/sign/done"`
`COMPANY_SIGNATORY_CREATED`	`"company/signatory/created"`
`COMPANY_SIGNATORY_INVITED`	`"company/signatory/invited"`
`COMPANY_SIGNATORY_UPDATED`	`"company/signatory/updated"`
`COMPANY_STATE_TAX_DONE`	`"company/stateTaxes/done"`
`COMPANY_STATE_TAX_EDIT`	`"company/stateTaxes/edit"`
`COMPANY_STATE_TAX_UPDATED`	`"company/stateTaxes/updated"`
`COMPANY_VIEW_FORM_TO_SIGN`	`"company/forms/view"`
`CONTRACTOR_ADDRESS_DONE`	`"contractor/address/done"`
`CONTRACTOR_ADDRESS_UPDATED`	`"contractor/address/updated"`
`CONTRACTOR_BANK_ACCOUNT_CREATED`	`"contractor/bankAccount/created"`
`CONTRACTOR_CREATE`	`"contractor/create"`
`CONTRACTOR_CREATED`	`"contractor/created"`
`CONTRACTOR_DELETED`	`"contractor/deleted"`
`CONTRACTOR_DOCUMENTS_DONE`	`"contractor/documents/done"`
`CONTRACTOR_INVITE_CONTRACTOR`	`"contractor/invite/selfOnboarding"`
`CONTRACTOR_NEW_HIRE_REPORT_DONE`	`"contractor/newHireReport/done"`
`CONTRACTOR_NEW_HIRE_REPORT_UPDATED`	`"contractor/newHireReport/updated"`
`CONTRACTOR_ONBOARDING_CONTINUE`	`"contractor/onboarding/continue"`
`CONTRACTOR_ONBOARDING_STATUS_UPDATED`	`"contractor/onboardingStatus/updated"`
`CONTRACTOR_PAYMENT_BACK_TO_EDIT`	`"contractor/payments/backToEdit"`
`CONTRACTOR_PAYMENT_CANCEL`	`"contractor/payments/cancel"`
`CONTRACTOR_PAYMENT_CREATE`	`"contractor/payments/create"`
`CONTRACTOR_PAYMENT_CREATED`	`"contractor/payments/created"`
`CONTRACTOR_PAYMENT_EDIT`	`"contractor/payments/edit"`
`CONTRACTOR_PAYMENT_EXIT`	`"contractor/payments/exit"`
`CONTRACTOR_PAYMENT_METHOD_DONE`	`"contractor/paymentMethod/done"`
`CONTRACTOR_PAYMENT_METHOD_UPDATED`	`"contractor/paymentMethod/updated"`
`CONTRACTOR_PAYMENT_PREVIEW`	`"contractor/payments/preview"`
`CONTRACTOR_PAYMENT_RFI_RESPOND`	`"contractor/payments/rfi/respond"`
`CONTRACTOR_PAYMENT_SUBMIT`	`"contractor/payments/submit"`
`CONTRACTOR_PAYMENT_UPDATE`	`"contractor/payments/update"`
`CONTRACTOR_PAYMENT_VIEW`	`"contractor/payments/view"`
`CONTRACTOR_PAYMENT_VIEW_DETAILS`	`"contractor/payments/view/details"`
`CONTRACTOR_PROFILE_DONE`	`"contractor/profile/done"`
`CONTRACTOR_SELF_ONBOARDING_CANCELLED`	`"contractor/selfOnboarding/cancelled"`
`CONTRACTOR_SELF_ONBOARDING_DONE`	`"contractor/selfOnboarding/done"`
`CONTRACTOR_SELF_ONBOARDING_START`	`"contractor/selfOnboarding/start"`
`CONTRACTOR_SIGN_DOCUMENT`	`"contractor/documents/sign"`
`CONTRACTOR_SUBMIT_DONE`	`"contractor/submit/done"`
`CONTRACTOR_UPDATE`	`"contractor/update"`
`CONTRACTOR_UPDATED`	`"contractor/updated"`
`CONTRACTOR_VIEW_DOCUMENT_TO_SIGN`	`"contractor/documents/view"`
`DISMISSAL_PAY_PERIOD_SELECTED`	`"dismissal/payPeriod/selected"`
`EMPLOYEE_BANK_ACCOUNT_CREATE`	`"employee/bankAccount/create"`
`EMPLOYEE_BANK_ACCOUNT_CREATED`	`"employee/bankAccount/created"`
`EMPLOYEE_BANK_ACCOUNT_DELETED`	`"employee/bankAccount/deleted"`
`EMPLOYEE_CHANGE_ELIGIBILITY_STATUS`	`"employee/employmentEligibility/change"`
`EMPLOYEE_COMPENSATION_CANCEL`	`"employee/compensations/cancel"`
`EMPLOYEE_COMPENSATION_CHANGE_CANCELLED`	`"employee/compensations/changeCancelled"`
`EMPLOYEE_COMPENSATION_CREATE`	`"employee/compensations/create"`
`EMPLOYEE_COMPENSATION_CREATED`	`"employee/compensations/created"`
`EMPLOYEE_COMPENSATION_DONE`	`"employee/compensations/done"`
`EMPLOYEE_COMPENSATION_RETURN_TO_LIST`	`"employee/compensations/returnToList"`
`EMPLOYEE_COMPENSATION_UPDATED`	`"employee/compensations/updated"`
`EMPLOYEE_CREATE`	`"employee/create"`
`EMPLOYEE_CREATED`	`"employee/created"`
`EMPLOYEE_DASHBOARD_TAB_CHANGE`	`"employee/dashboard/tabChange"`
`EMPLOYEE_DEDUCTION_ADD`	`"employee/deductions/add"`
`EMPLOYEE_DEDUCTION_CANCEL`	`"employee/deductions/cancel"`
`EMPLOYEE_DEDUCTION_CANCEL_EMPTY`	`"employee/deductions/cancelEmpty"`
`EMPLOYEE_DEDUCTION_CREATED`	`"employee/deductions/created"`
`EMPLOYEE_DEDUCTION_DELETED`	`"employee/deductions/deleted"`
`EMPLOYEE_DEDUCTION_DELETED_EMPTY`	`"employee/deductions/deletedEmpty"`
`EMPLOYEE_DEDUCTION_DONE`	`"employee/deductions/done"`
`EMPLOYEE_DEDUCTION_EDIT`	`"employee/deductions/edit"`
`EMPLOYEE_DEDUCTION_UPDATED`	`"employee/deductions/updated"`
`EMPLOYEE_DELETED`	`"employee/deleted"`
`EMPLOYEE_DISMISS`	`"employee/dismiss"`
`EMPLOYEE_DOCUMENTS_DONE`	`"employee/documents/done"`
`EMPLOYEE_EMPLOYMENT_ELIGIBILITY_DONE`	`"employee/employmentEligibility/done"`
`EMPLOYEE_FEDERAL_TAXES_DONE`	`"employee/federalTaxes/done"`
`EMPLOYEE_FEDERAL_TAXES_EDIT`	`"employee/federalTaxes/edit"`
`EMPLOYEE_FEDERAL_TAXES_UPDATED`	`"employee/federalTaxes/updated"`
`EMPLOYEE_FORMS_DONE`	`"employee/forms/done"`
`EMPLOYEE_HOME_ADDRESS_CREATED`	`"employee/addresses/home/created"`
`EMPLOYEE_HOME_ADDRESS_UPDATED`	`"employee/addresses/home/updated"`
`EMPLOYEE_JOB_ADD`	`"employee/job/add"`
`EMPLOYEE_JOB_ADD_ANOTHER`	`"employee/job/addAnother"`
`EMPLOYEE_JOB_CREATED`	`"employee/job/created"`
`EMPLOYEE_JOB_DELETED`	`"employee/job/deleted"`
`EMPLOYEE_JOB_EDIT`	`"employee/job/edit"`
`EMPLOYEE_JOB_UPDATED`	`"employee/job/updated"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_ANOTHER_JOB_FORM_CANCELLED`	`"employee/management/compensation/addAnotherJobForm/cancelled"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_ANOTHER_JOB_FORM_SUBMITTED`	`"employee/management/compensation/addAnotherJobForm/submitted"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_JOB_FORM_CANCELLED`	`"employee/management/compensation/addJobForm/cancelled"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_ADD_JOB_FORM_SUBMITTED`	`"employee/management/compensation/addJobForm/submitted"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_ALERT_DISMISSED`	`"employee/management/compensation/alertDismissed"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_ADD_ANOTHER_REQUESTED`	`"employee/management/compensation/card/addAnotherRequested"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_ADD_REQUESTED`	`"employee/management/compensation/card/addRequested"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_CHANGE_CANCELLED`	`"employee/management/compensation/card/changeCancelled"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_EDIT_REQUESTED`	`"employee/management/compensation/card/editRequested"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_CARD_JOB_DELETED`	`"employee/management/compensation/card/jobDeleted"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_EDIT_FORM_CANCELLED`	`"employee/management/compensation/editForm/cancelled"`
`EMPLOYEE_MANAGEMENT_COMPENSATION_EDIT_FORM_SUBMITTED`	`"employee/management/compensation/editForm/submitted"`
`EMPLOYEE_MANAGEMENT_DEDUCTIONS_ALERT_DISMISSED`	`"employee/management/deductions/alertDismissed"`
`EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_ADD_REQUESTED`	`"employee/management/deductions/card/addRequested"`
`EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_DELETED`	`"employee/management/deductions/card/deleted"`
`EMPLOYEE_MANAGEMENT_DEDUCTIONS_CARD_EDIT_REQUESTED`	`"employee/management/deductions/card/editRequested"`
`EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_CANCELLED`	`"employee/management/deductions/editForm/cancelled"`
`EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_CREATED`	`"employee/management/deductions/editForm/created"`
`EMPLOYEE_MANAGEMENT_DEDUCTIONS_EDIT_FORM_UPDATED`	`"employee/management/deductions/editForm/updated"`
`EMPLOYEE_MANAGEMENT_DOCUMENTS_CARD_VIEW_REQUESTED`	`"employee/management/documents/card/viewRequested"`
`EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_ALERT_DISMISSED`	`"employee/management/federalTaxes/alertDismissed"`
`EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_CARD_EDIT_REQUESTED`	`"employee/management/federalTaxes/card/editRequested"`
`EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_EDIT_FORM_CANCELLED`	`"employee/management/federalTaxes/editForm/cancelled"`
`EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_EDIT_FORM_SUBMITTED`	`"employee/management/federalTaxes/editForm/submitted"`
`EMPLOYEE_MANAGEMENT_HOME_ADDRESS_CREATED`	`"employee/management/homeAddress/created"`
`EMPLOYEE_MANAGEMENT_HOME_ADDRESS_DELETED`	`"employee/management/homeAddress/deleted"`
`EMPLOYEE_MANAGEMENT_HOME_ADDRESS_EDIT_CANCELLED`	`"employee/management/homeAddress/editCancelled"`
`EMPLOYEE_MANAGEMENT_HOME_ADDRESS_EDIT_REQUESTED`	`"employee/management/homeAddress/editRequested"`
`EMPLOYEE_MANAGEMENT_HOME_ADDRESS_UPDATED`	`"employee/management/homeAddress/updated"`
`EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_ALERT_DISMISSED`	`"employee/management/paymentMethod/alertDismissed"`
`EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_BANK_FORM_CANCELLED`	`"employee/management/paymentMethod/bankForm/cancelled"`
`EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_BANK_FORM_SUBMITTED`	`"employee/management/paymentMethod/bankForm/submitted"`
`EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_ADD_REQUESTED`	`"employee/management/paymentMethod/card/addRequested"`
`EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_BANK_ACCOUNT_DELETED`	`"employee/management/paymentMethod/card/bankAccountDeleted"`
`EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_CARD_SPLIT_REQUESTED`	`"employee/management/paymentMethod/card/splitRequested"`
`EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_SPLIT_FORM_CANCELLED`	`"employee/management/paymentMethod/splitForm/cancelled"`
`EMPLOYEE_MANAGEMENT_PAYMENT_METHOD_SPLIT_FORM_SUBMITTED`	`"employee/management/paymentMethod/splitForm/submitted"`
`EMPLOYEE_MANAGEMENT_PAYSTUBS_CARD_DOWNLOAD_REQUESTED`	`"employee/management/paystubs/card/downloadRequested"`
`EMPLOYEE_MANAGEMENT_PAYSTUBS_CARD_DOWNLOADED`	`"employee/management/paystubs/card/downloaded"`
`EMPLOYEE_MANAGEMENT_PROFILE_ALERT_DISMISSED`	`"employee/management/profile/alertDismissed"`
`EMPLOYEE_MANAGEMENT_PROFILE_EDIT_CANCELLED`	`"employee/management/profile/editCancelled"`
`EMPLOYEE_MANAGEMENT_PROFILE_EDIT_REQUESTED`	`"employee/management/profile/editRequested"`
`EMPLOYEE_MANAGEMENT_PROFILE_UPDATED`	`"employee/management/profile/updated"`
`EMPLOYEE_MANAGEMENT_STATE_TAXES_ALERT_DISMISSED`	`"employee/management/stateTaxes/alertDismissed"`
`EMPLOYEE_MANAGEMENT_STATE_TAXES_EDIT_CANCELLED`	`"employee/management/stateTaxes/editCancelled"`
`EMPLOYEE_MANAGEMENT_STATE_TAXES_EDIT_REQUESTED`	`"employee/management/stateTaxes/editRequested"`
`EMPLOYEE_MANAGEMENT_STATE_TAXES_UPDATED`	`"employee/management/stateTaxes/updated"`
`EMPLOYEE_MANAGEMENT_WORK_ADDRESS_CREATED`	`"employee/management/workAddress/created"`
`EMPLOYEE_MANAGEMENT_WORK_ADDRESS_DELETED`	`"employee/management/workAddress/deleted"`
`EMPLOYEE_MANAGEMENT_WORK_ADDRESS_EDIT_CANCELLED`	`"employee/management/workAddress/editCancelled"`
`EMPLOYEE_MANAGEMENT_WORK_ADDRESS_EDIT_REQUESTED`	`"employee/management/workAddress/editRequested"`
`EMPLOYEE_MANAGEMENT_WORK_ADDRESS_UPDATED`	`"employee/management/workAddress/updated"`
`EMPLOYEE_ONBOARDING_DOCUMENTS_CONFIG_UPDATED`	`"employee/onboardingDocumentsConfig/updated"`
`EMPLOYEE_ONBOARDING_DONE`	`"employee/onboarding/done"`
`EMPLOYEE_ONBOARDING_STATUS_UPDATED`	`"employee/onboardingStatus/updated"`
`EMPLOYEE_PAYMENT_METHOD_DONE`	`"employee/paymentMethod/done"`
`EMPLOYEE_PAYMENT_METHOD_RESET`	`"employee/paymentMethod/reset"`
`EMPLOYEE_PAYMENT_METHOD_UPDATED`	`"employee/paymentMethod/updated"`
`EMPLOYEE_PROFILE_DONE`	`"employee/profile/done"`
`EMPLOYEE_REHIRE`	`"employee/rehire"`
`EMPLOYEE_RETURN_TO_LIST`	`"employee/returnToList"`
`EMPLOYEE_SELF_ONBOARDING_START`	`"employee/selfOnboarding/start"`
`EMPLOYEE_SIGN_FORM`	`"employee/forms/sign"`
`EMPLOYEE_SPLIT_PAYCHECK`	`"employee/bankAccount/split"`
`EMPLOYEE_SPLIT_PAYMENT`	`"employee/paymentMethod/split"`
`EMPLOYEE_STATE_TAXES_DONE`	`"employee/stateTaxes/done"`
`EMPLOYEE_STATE_TAXES_UPDATED`	`"employee/stateTaxes/updated"`
`EMPLOYEE_SUMMARY_VIEW`	`"employee/summary"`
`EMPLOYEE_TERMINATION_CANCELLED`	`"employee/termination/cancelled"`
`EMPLOYEE_TERMINATION_CREATED`	`"employee/termination/created"`
`EMPLOYEE_TERMINATION_DONE`	`"employee/termination/done"`
`EMPLOYEE_TERMINATION_EDIT`	`"employee/termination/edit"`
`EMPLOYEE_TERMINATION_PAYROLL_CREATED`	`"employee/termination/payroll/created"`
`EMPLOYEE_TERMINATION_PAYROLL_FAILED`	`"employee/termination/payroll/failed"`
`EMPLOYEE_TERMINATION_RUN_OFF_CYCLE_PAYROLL`	`"employee/termination/runOffCyclePayroll"`
`EMPLOYEE_TERMINATION_RUN_PAYROLL`	`"employee/termination/runPayroll"`
`EMPLOYEE_TERMINATION_UPDATED`	`"employee/termination/updated"`
`EMPLOYEE_TERMINATION_VIEW_SUMMARY`	`"employee/termination/viewSummary"`
`EMPLOYEE_UPDATE`	`"employee/update"`
`EMPLOYEE_UPDATED`	`"employee/updated"`
`EMPLOYEE_VIEW_FORM_TO_SIGN`	`"employee/forms/view"`
`EMPLOYEE_WORK_ADDRESS`	`"employee/addresses/work"`
`EMPLOYEE_WORK_ADDRESS_CREATED`	`"employee/addresses/work/created"`
`EMPLOYEE_WORK_ADDRESS_DELETED`	`"employee/addresses/work/deleted"`
`EMPLOYEE_WORK_ADDRESS_UPDATE`	`"employee/addresses/work/update"`
`EMPLOYEE_WORK_ADDRESS_UPDATED`	`"employee/addresses/work/updated"`
`EMPLOYEES_LIST`	`"company/employees"`
`ERROR`	`"ERROR"`
`INFORMATION_REQUEST_FORM_CANCEL`	`"informationRequest/form/cancel"`
`INFORMATION_REQUEST_FORM_DONE`	`"informationRequest/form/done"`
`INFORMATION_REQUEST_FORM_SUBMIT`	`"informationRequest/form/submit"`
`INFORMATION_REQUEST_RESPOND`	`"informationRequest/respond"`
`OFF_CYCLE_CREATED`	`"offCycle/created"`
`OFF_CYCLE_DEDUCTIONS_CHANGE`	`"offCycle/deductionsChange"`
`OFF_CYCLE_SELECT_REASON`	`"offCycle/selectReason"`
`PAY_SCHEDULE_CREATE`	`"paySchedule/create"`
`PAY_SCHEDULE_CREATED`	`"paySchedule/created"`
`PAY_SCHEDULE_DELETE`	`"paySchedule/delete"`
`PAY_SCHEDULE_DELETED`	`"paySchedule/deleted"`
`PAY_SCHEDULE_DONE`	`"paySchedule/done"`
`PAY_SCHEDULE_UPDATE`	`"paySchedule/update"`
`PAY_SCHEDULE_UPDATED`	`"paySchedule/updated"`
`PAYROLL_DELETED`	`"payroll/deleted"`
`PAYROLL_EXIT_FLOW`	`"payroll/saveAndExit"`
`PAYROLL_SKIPPED`	`"payroll/skipped"`
`PAYROLL_WIRE_FORM_CANCEL`	`"payroll/wire/form/cancel"`
`PAYROLL_WIRE_FORM_DONE`	`"payroll/wire/form/done"`
`PAYROLL_WIRE_INSTRUCTIONS_CANCEL`	`"payroll/wire/instructions/cancel"`
`PAYROLL_WIRE_INSTRUCTIONS_DONE`	`"payroll/wire/instructions/done"`
`PAYROLL_WIRE_INSTRUCTIONS_SELECT`	`"payroll/wire/instructions/select"`
`PAYROLL_WIRE_START_TRANSFER`	`"payroll/wire/startTransfer"`
`RECOVERY_CASE_RESOLVE`	`"recoveryCase/resolve"`
`RECOVERY_CASE_RESUBMIT`	`"recoveryCase/resubmit"`
`RECOVERY_CASE_RESUBMIT_CANCEL`	`"recoveryCase/resubmit/cancel"`
`RECOVERY_CASE_RESUBMIT_DONE`	`"recoveryCase/resubmit/done"`
`REVIEW_PAYROLL`	`"payroll/review"`
`ROBOT_MACHINE_DONE`	`"done"`
`RUN_OFF_CYCLE_PAYROLL`	`"runPayroll/offCycle/start"`
`RUN_PAYROLL_BACK`	`"runPayroll/back"`
`RUN_PAYROLL_BLOCKER_RESOLUTION_ATTEMPTED`	`"runPayroll/blocker/resolutionAttempted"`
`RUN_PAYROLL_BLOCKERS_DETECTED`	`"runPayroll/blockers/detected"`
`RUN_PAYROLL_BLOCKERS_VIEW_ALL`	`"runPayroll/blockers/viewAll"`
`RUN_PAYROLL_CALCULATED`	`"runPayroll/calculated"`
`RUN_PAYROLL_CANCELLED`	`"runPayroll/cancelled"`
`RUN_PAYROLL_CANCELLED_ALERT_DISMISSED`	`"runPayroll/cancelled/alertDismissed"`
`RUN_PAYROLL_DATES_CONFIGURED`	`"runPayroll/dates/configured"`
`RUN_PAYROLL_EDIT`	`"runPayroll/edit"`
`RUN_PAYROLL_EMPLOYEE_CANCELLED`	`"runPayroll/employee/cancelled"`
`RUN_PAYROLL_EMPLOYEE_EDIT`	`"runPayroll/employee/edit"`
`RUN_PAYROLL_EMPLOYEE_SAVED`	`"runPayroll/employee/saved"`
`RUN_PAYROLL_EMPLOYEE_SKIP`	`"runPayroll/employee/skip"`
`RUN_PAYROLL_GROSS_UP_CALCULATED`	`"runPayroll/grossUp/calculated"`
`RUN_PAYROLL_GROSS_UP_SELECTED`	`"runPayroll/grossUp/selected"`
`RUN_PAYROLL_PDF_PAYSTUB_VIEWED`	`"runPayroll/pdfPaystub/viewed"`
`RUN_PAYROLL_PROCESSED`	`"runPayroll/processed"`
`RUN_PAYROLL_PROCESSING_FAILED`	`"runPayroll/processingFailed"`
`RUN_PAYROLL_RECEIPT_GET`	`"runPayroll/receipt/get"`
`RUN_PAYROLL_RECEIPT_VIEWED`	`"runPayroll/receipt/viewed"`
`RUN_PAYROLL_SELECTED`	`"runPayroll/selected"`
`RUN_PAYROLL_SUBMITTED`	`"runPayroll/submitted"`
`RUN_PAYROLL_SUBMITTING`	`"runPayroll/submitting"`
`RUN_PAYROLL_SUMMARY_VIEWED`	`"runPayroll/summary/viewed"`
`RUN_TRANSITION_PAYROLL`	`"transition/runPayroll"`
`TIME_OFF_ADD_EMPLOYEES_BACK`	`"timeOff/addEmployees/back"`
`TIME_OFF_ADD_EMPLOYEES_DONE`	`"timeOff/addEmployees/done"`
`TIME_OFF_ADD_EMPLOYEES_ERROR`	`"timeOff/addEmployees/error"`
`TIME_OFF_ADD_EMPLOYEES_TO_POLICY`	`"timeOff/addEmployeesToPolicy"`
`TIME_OFF_BACK_TO_LIST`	`"timeOff/backToList"`
`TIME_OFF_CHANGE_SETTINGS`	`"timeOff/changeSettings"`
`TIME_OFF_CREATE_POLICY`	`"timeOff/createPolicy"`
`TIME_OFF_DELETE_POLICY_DONE`	`"timeOff/deletePolicy/done"`
`TIME_OFF_EDIT_HOLIDAY_POLICY`	`"timeOff/editHolidayPolicy"`
`TIME_OFF_EDIT_POLICY`	`"timeOff/editPolicy"`
`TIME_OFF_HOLIDAY_ADD_EMPLOYEES`	`"timeOff/holidayAddEmployees"`
`TIME_OFF_HOLIDAY_ADD_EMPLOYEES_DONE`	`"timeOff/holidayAddEmployees/done"`
`TIME_OFF_HOLIDAY_ADD_EMPLOYEES_ERROR`	`"timeOff/holidayAddEmployees/error"`
`TIME_OFF_HOLIDAY_CREATE_ERROR`	`"timeOff/holidayCreate/error"`
`TIME_OFF_HOLIDAY_SELECTION_DONE`	`"timeOff/holidaySelection/done"`
`TIME_OFF_HOLIDAY_SELECTION_EDIT_DONE`	`"timeOff/holidaySelection/editDone"`
`TIME_OFF_POLICY_CREATE_ERROR`	`"timeOff/policyCreate/error"`
`TIME_OFF_POLICY_DETAILS_DONE`	`"timeOff/policyDetails/done"`
`TIME_OFF_POLICY_SETTINGS_BACK`	`"timeOff/policySettings/back"`
`TIME_OFF_POLICY_SETTINGS_DONE`	`"timeOff/policySettings/done"`
`TIME_OFF_POLICY_SETTINGS_ERROR`	`"timeOff/policySettings/error"`
`TIME_OFF_POLICY_TYPE_SELECTED`	`"timeOff/policyTypeSelected"`
`TIME_OFF_VIEW_HOLIDAY_EMPLOYEES`	`"timeOff/viewHolidayEmployees"`
`TIME_OFF_VIEW_HOLIDAY_SCHEDULE`	`"timeOff/viewHolidaySchedule"`
`TIME_OFF_VIEW_POLICY`	`"timeOff/viewPolicy"`
`TIME_OFF_VIEW_POLICY_DETAILS`	`"timeOff/viewPolicyDetails"`
`TIME_OFF_VIEW_POLICY_EMPLOYEES`	`"timeOff/viewPolicyEmployees"`
`TRANSITION_CREATED`	`"transition/created"`
`TRANSITION_PAYROLL_SKIPPED`	`"transition/payrollSkipped"`

Utility types

EventType

EventType = typeof componentEvents[keyof typeof componentEvents]

Union of every event string value defined in componentEvents.

Remarks

This is the type of the first argument passed to a component's onEvent handler. Use it when typing your own handler so TypeScript can narrow against the specific event keys you care about.

Example

import { componentEvents, type EventType } from '@gusto/embedded-react-sdk'

const handleEvent = (type: EventType, data: unknown) => {
  if (type === componentEvents.EMPLOYEE_CREATED) {
    // ...
  }
}

OnEventType

OnEventType<K, T> = (type: K, data?: T) => void

Callback signature for an SDK component event emitter, invoked with an event key and optional payload.

Remarks

Supply a function of this shape as the onEvent prop on any SDK feature component. The type argument is always one of the constants from componentEvents. The data argument is event-specific — some events carry no payload while others include the full API response body. Refer to each component's event table for details.

Type Parameters

Type Parameter	Description
`K`	The discriminating event-key type, typically a componentEvents member.
`T`	The shape of the optional event payload.

Parameters

Parameter	Type
`type`	`K`
`data?`	`T`

Returns

void

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

componentEvents

Remarks

Example

Type Declaration

Utility types

EventType

Remarks

Example

OnEventType

Remarks

Type Parameters

Parameters

Returns

Uh oh!

FilesExpand file tree

events.md

Latest commit

History

events.md

File metadata and controls

componentEvents

Remarks

Example

Type Declaration

Utility types

EventType

Remarks

Example

OnEventType

Remarks

Type Parameters

Parameters

Returns