Gather the information necessary to onboard a worker onto payroll by collecting it directly from them with this experience.
Worker onboarding experience
This is a worker facing experience that provides a worker user with the ability to enter all of their personal, tax, and bank related information that will be required by their employer in order to pay them through payroll.
Embedded usage
Element name: worker-onboarding
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 WORKER_USER or WORKER_ONBOARDING access role for the specified Worker. |
workerId | String | Required. The id of the Worker. |
showWelcomeView | Boolean | Controls if the first welcome view should be shown before launching the workflow. Default value is true if unspecified. |
Refer to the reference on creating elements for the additional options that are available to all elements.
Example
salsa.elements.create('worker-onboarding', {
userToken: 'eyJhbGciO...ajs0Wqw',
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 | 'worker-onboarding' |
employerId | String | The id of the Employer. |
workerId | String | The id of the Worker. |
Hosted usage
URL path: worker-onboarding
Refer to the guide on how to onboard workers with Salsa UI for more detailed instructions on how you can invite workers to use this hosted UI experience.
Options
| Name | Type | Description |
|---|---|---|
userToken | String | Required. A User Token with WORKER_ONBOARDING access role for the specified Worker. |
id | String | Required. The id of the HostedWorkerOnboarding instance associated with a particular Worker. |
Example
https://components.salsa.dev/hosted/worker-onboarding?id=hstwronbrd_7c020031-58d2-40ce-bf90-f0bbf078d373&userToken=eyJhbGciO...ajs0Wqw