Dive into a completely refreshed onboarding experience that will guide your users with gusto. The new checklist feature not only ensures your users are thoroughly onboarded but also keeps them deeply engaged. All of this is neatly packed inside our Gleap widget!

​
Open the checklists overview

Open the checklists overview with the method below. 
Gleap.openChecklists();

​
Manually start a checklist

Checklists can be sent either through trigger rules or manually with the method below. 
Gleap.startChecklist("outboundId");
You can find the outboundId within the checklist editor.
Please note that SDK version 12.1.0 or higher is required to send checklists.

​
Get checklist data

Retrieve checklist data programmatically using the checklist ID and project identifier. 
Gleap.getChecklistData("outboundId", "sharedKey").then((data) => {
    console.log(data);
});
The sharedKey is optional.

​
Listen for checklist events

You can listen to various checklist events to track user progress and interactions.

​
Checklist loaded event

Gleap.on('checklist-loaded', (data) => {
  console.log('Checklist loaded:', data);
});

​
Step completed event

Gleap.on('checklist-step-completed', (data) => {
  console.log('Step completed:', data.stepId);
});

​
Checklist completed event

Gleap.on('checklist-completed', (data) => {
  console.log('Checklist completed!');
});