Skip to content

Checklists ​

A checklist helps visitors complete a series of actions in your product. Open “Checklists” and click “Create checklist”. The “Internal name” is for your team; visitors see the “Title” and “Description”.

Access and permissions ​

To view the list, you need the View permission in the “Checklists” row. Creating a draft requires Create; saving, publishing, and changing its status require Edit. The account owner has all permissions.

Content ​

On the “Content” tab, enter the “Title” and “Description”, then click “Add item”. Each item has:

  • “Name” and “Description”;
  • “When to mark complete”: “After click”, “After popup opens”, “After tour completion”, “After an event”, or “Manually”;
  • “Action”: “No action”, “Open popup”, “Start tour”, “Open URL”, or “Complete item”;
  • “Optional item”. Optional items are excluded from the progress calculation.

For “Open popup”, select active content in the “Popup” field. The popups guide explains how to create it. For “Start tour”, select an active tour; for “Open URL”, fill in “Link”.

Drag an item by the icon on its left to change the order. The item menu offers “Duplicate”, “Move up”, “Move down”, and “Delete”. After deleting an item, click “Undo” in the notification to restore it.

If you select “After an event”, specify the “Event” and, if needed, “Delay, ms”. Events appear after you set up collection on the “Integration” page.

Checklist draft editor with items

A saved example draft. Item actions still need to be configured before enabling it.

Appearance, display conditions, and settings ​

On the “Appearance” tab, enable “Show progress” and choose “Bar”, “Segments”, or “Text only”. Under “After completion”, you can enable “Hide after closing”, “Can be closed”, and “Can restart”.

Set rules on the “Display conditions” tab. All rules must be met at the same time; without conditions, the checklist is available to all visitors.

On the “Settings” tab, fill in “Internal name” and “Priority”. These fields do not change the card text visitors see.

Preview, saving, and publishing ​

The “Preview” panel updates immediately and shows the card. Links and other content do not open in it. On a narrow screen, click “Preview” in the header.

Draft and disabled checklists save after a short pause. The header shows the save status. If an error occurs, click “Retry” or “Save”.

Click “Enable” once the required fields are complete. Changes to an active checklist do not become available to visitors automatically: click “Save changes”. The “Save” button saves the draft without updating the version on your site.

If another session saved the checklist first, a “Change conflict” message appears. Click “Load current version” to accept the server version. To keep your edits, first click “Copy your JSON” and paste the copy somewhere safe.