Install Widget

  1. Copy the following code snippet and paste it just before the closing body tag of the page where you want your checklist to appear for logged-in users, for example your dashboard:
    
    <script src="https://checklist.onboardlist.com/script.js"></script>
    <script>
      OnboardList.initialize({
        hostname: 'www.yourdomain.com',
        firstName: 'John',
        lastName: 'Doe',
        email: 'john.doe@gmail.com',
        identifier: 1
      });
    </script>
    
    
  2. Set the hostname in the code snippet to the hostname you entered when you added your domain. This is how OnboardList knows which checklist to display for your users.
  3. Set the firstName, lastName, and email properties in the code snippet to the current user's first name, last name, and email address.
  4. Set the identifier property in the code snippet to a unique identifier for the current user, typically a database ID. This lets OnboardList track the state of each user's checklist.

    Here is an example of how the edited code snippet might look if you have a JavaScript application with user data stored in a user object:
    
      <script src="https://checklist.onboardlist.com/script.js"></script>
      <script>
        OnboardList.initialize({
          hostname: 'www.yourdomain.com',
          firstName: user.firstName,
          lastName: user.lastName,
          email: user.email,
          identifier: user.id
        });
      </script>
    
    
  5. Log in to your app and make sure the OnboardList checklist widget appears on your dashboard. If it doesn't, check the browser's JavaScript console in for errors. Please contact OnboardList support if you need help troubleshooting your installation, we're glad to help!
  6. Sign in to the OnboardList dashboard at www.onboardlist.com/signin, then click on Domains. On the Domains page under User Signups, click Manage Signups. You should see user information from the account you used to test the widget in the previous step.
  7. Once you have confirmed the widget is being displayed and data is being collected in the previous two steps, copy and paste the code snippet into any other pages where you want the checklist widget to appear. Note it should only be added to pages for logged in users.