Reference

Employer onboard workers

Gather the information necessary to onboard multiple workers onto payroll at once.

Available as:
Employer onboard workers

Employer Onboard Workers

Options

NameTypeDescription
userTokenStringRequired. A User Token with EMPLOYER_ADMIN access role for the specified Employer.
employerIdStringRequired. The id of the Employer.
displayModeStringConfigures the layout of the embedded experience. Options are: drawer, modal, and inline. Defaults to drawer if not provided.
titleStringOptional custom title to display in the layout.
closeDisabledBooleanApplicable to modal and drawer modes. Disables the close functionality. Consumers are responsible for handling the behavior triggered when the close event occurs. Defaults to false.

Refer to the reference on creating elements for the additional options that are available to all elements.

Embedded usage

Element name: employer-onboard-workers

Refer to the guide on how to embed an Element with Salsa.js for more detailed instructions.

Example

salsa.elements.create('employer-onboard-workers', {
  userToken: 'eyJhbGciO...ajs0Wqw', 
  employerId: 'er_e8343fc7-9d63-4cc5-81ed-c573fc666d37',
  displayMode: 'modal',
  title: 'My custom title',
  closeDisabled: true
});

Events

Refer to the documentation on Element events for more information about events and instructions on how to consume them.

complete event

The complete event is triggered when the user completes the flow of onboarding workers.

Event object properties

NameTypeDescription
elementTypeStringemployer-onboard-workers
employerIdStringThe id of Employer.
displayModeStringThe display mode used (drawer, modal or inline).

close event

The close event is triggered when the user completes cancels onboarding flow or closes the drawer/modal.

Event object properties

NameTypeDescription
elementTypeStringemployer-onboard-workers
employerIdStringThe id of Employer.
displayModeStringThe display mode used (drawer, modal or inline).