Onboarding Checklists

Ship guided onboarding checklists without touching the dashboard.

Checklists give new users a guided list of setup tasks inside your app. The skill lets your agent create checklists with tasks, targeting, and completion rules, then publish them — useful when a new feature should slot into your onboarding flow the day it ships.

This guide covers the agent skill and API. For the full product, see Userorbit checklists.

Ask your agent

Add a 'Connect your Slack' task to the onboarding checklist
Create a getting-started checklist with tasks for profile, first project, and inviting a teammate
Unpublish the beta checklist

Endpoints

All endpoints are POST https://api.userorbit.com/api/v1/<endpoint> with a Bearer API key and x-team-id header.

Endpoint	What it does
`checklists.create`	Create with tasks, targeting, and design configuration
`checklists.list / drafts / all / count / info`	Browse checklists
`checklists.update`	Edit tasks, targeting, publish/unpublish
`checklists.delete`	Remove a checklist

Example

Examplechecklists

curl -s -X POST "https://api.userorbit.com/api/v1/checklists.list" \
  -H "Authorization: Bearer $USERORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "x-team-id: $USERORBIT_TEAM_ID" \
  -d '{}'

Full request and response schemas: references/api.md.

← Interactive Demos In-App Surveys →