OnboardList Documentation
Widget
Copy the following JavaScript code snippet and add it to your source code where you want your checklist to appear for logged-in users, for example in your dashboard:
<script src="https://checklist.onboardlist.com/script.js"></script>
<script>
OnboardList.initialize({
firstName: '',
lastName: '',
email: '',
checklistId: '',
});
</script>Programmatically set the firstName, lastName, and email properties in the code snippet to the current user's first name, last name, and email address. OnboardList uses this data to track the progress of each user in your onboarding checklist and send reminder emails.
Set the checklistId property to the Checklist ID shown in the OnboardList dashboard under Checklists (you can use the Copy button to copy the Checklist ID). Note that if you have several checklists for different user types, you'll need to set the checklistId value using a variable.
Here is an example showing how to load https://checklist.onboardlist.com/script.js and call the OnboardList.initialize() function in a React application:
useEffect(() => {
let script = document.getElementById('OnboardListScript');
if (!script) {
script = document.createElement('script');
script.async = true;
script.id = 'OnboardListScript';
script.src = 'https://checklist.onboardlist.com/script.js';
script.onload = () => {
window.OnboardList.initialize({
firstName: user.firstName,
lastName: user.lastName,
email: user.email,
checklistId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
});
};
document.body.appendChild(script);
}
}, [user]);
Once you've installed the code snippet, log in to your app and make sure the OnboardList checklist widget appears. Note for the widget to appear, the checklist must have at least one active step and the user must not have completed the checklist.
If the widget doesn't appear, check your browser's JavaScript console in for errors. Also double-check the user's email address has not been added to exclusion list in the OnboardList dashboard under Exclusions, since that hides the checklist from those users.