Group based checklists

Please note, this feature is not available for all accounts currently. If you want to try it please message us in our live chat or at it requires you have the Boost plan.

You can show a checklist that will share its state through a group of users. This can be handy when your onboarding is company based, not user based. For example, if your onboarding steps require a company logo to be uploaded and a company name to be filled, typically only the first user from the company should do this. Group checklists can be a solution to this.

How to set up

Put users into groups in the integration code

When you integrated the Product Fruits JavaScript code into your application, you had to pass atleast a username. To be able to use the grouping feature, you have to extend this information with a group ID to which the user belongs. A group ID should be a unique identifier of the group, for example, a company ID.

To do this, extend the user information object like this:

const productFruitsUserData = {
   username: '', // the unique user ID, this property is required
   firstname: '',
   lastname: '',
   props: {
      customProperty1: ''
   /* THIS IS IMPORTANT - assign the group ID here */
   group: {
      groupId: 'a unique group ID'

When you send this user to Product Fruits, you should be able to see this group information in the Tracked Users section in the user detail.

Create a checklist

Create a new checklist or open an existing one (which should be group based) and switch it to the group mode.

You can now design your checklist as usual. Once you activate it, all users in the same group ID will share the state of the checklist.


Group checklists have some limitations:

  • Currently, the user can be a member of only one group.
    • If you have a multiple groups scenario, it might still work in some use cases. For example, if one user can be a part of multiple companies, you can reassign the group ID when the user logs in to a particular company.
  • Only checklist items state is group based, not tour states. That means if a checklist item launches a tour, the checklist item will be marked as completed for all users in the group, but the tour can be seen by multiple users. This won't be an issue if the tour trigger is set to Manually.


A typical issue is you cannot see your checklist even if it's activated. That means the group ID is not properly assigned to the user. You can use our debugger to check this.