Provides the employer the ability to continue hiring new workers after the employer itself has already joined the payroll, so you will need to go through the setup process for new workers as they join.
This is a employer facing experience that enables an employer user to easily onboard additional workers onto payroll after they have already their initial employer onboarding. For instance, this is may be used for when the employer hires new workers in the future, or to complete the onboarding for any workers that they may have skipped during their initial employer onboarding.
Embedded usage
Element name: onboard-worker
Refer to the guide on how to embed an Element with Salsa.js for more detailed instructions.
Options
Name | Type | Description |
---|---|---|
userToken | String | Required. A User Token with EMPLOYER_ADMIN access role for the specified Employer. |
employerId | String | Required. The id of the Employer. |
workerId | String | Required. The id of the Worker. |
Refer to the reference on creating elements for the additional options that are available to all elements.
Example
salsa.elements.create('onboard-worker', {
userToken: 'eyJhbGciO...ajs0Wqw',
employerId: 'er_e8343fc7-9d63-4cc5-81ed-c573fc666d37'
workerId: 'wr_deb6f260-fa58-4aa8-a827-3ae7787f9650'
...
});
Events
Refer to the documentation on Element events for more information about events and instructions on how to consume them.
complete
event
complete
eventThe complete
event is triggered when the user completes the onboarding workflow.
Event object properties
Name | Type | Description |
---|---|---|
elementType | String | 'onboard-worker' |
employerId | String | The id of the Employer. |
workerId | String | The id of the Worker. |