Docs

Checklists

Onboarding tasks people work through from a launcher button. Items can tick themselves off.

A checklist gets new users to their first result. It sits behind a launcher button, and each item is one task.

Items

Each item has a title, an optional description and an optional action:

  • Start a tour that shows how to do the task.
  • Open a URL, like the settings page where the task happens.

Items complete themselves, so people don't have to tick them by hand:

Completes whenExample
A tour finishesThe item starts the "Create a report" tour, and completes when it's done.
Your app tracks an eventCueston.track("Report created")
The person visits a pagehttps://app.example.com/settings/billing*
The person ticks it offFor tasks Cueston can't see

A checklist has at most 20 items; three to seven is plenty.

For people you identify, progress is saved in Cueston and follows them across devices.

The launcher

Set the launcher's position and label, and whether the checklist opens on its own the first time. An auto-opening checklist counts toward the workspace's pop-up limits. When the help hub is on, checklists live in it instead of their own launcher.

Automate it

  • REST API: /api/checklists. See the API reference.
  • AI agents: create_checklist, with event names from list_event_names. See MCP tools.

On this page