Skip to content
Knowledge sections

Onboarding checklist

The dashboard's setup steps, derived from live workspace state and dismissable by owners and admins.

onboardingworkspacedashboard
On this page

Every workspace dashboard opens with an Onboarding Checklist: the handful of things a new Workspace usually sets up, with a plain "3 of 5" count. Each step links to the page that completes it.

The steps

StepComplete whenCompletes at
Invite a memberthe workspace has more than one MemberMembers
Create an API tokenat least one active API Token existsAPI tokens
Add a webhook endpointat least one Webhook Endpoint existsWebhooks
Enable two-factor on your accountthe signed-in user's account has two-factor enabledAccount
Choose a planthe workspace is on a plan other than the free StarterBilling

The plan step appears only when billing is configured (Stripe secret and price ids set). Without a provider the checklist has four steps, which is what the Seed Workspace shows locally.

Nothing is stored per step

The steps are computed on every read by the workspaceProgress projection in the capabilities package, from the same services the rest of the app uses. There is no "step done" flag to get out of sync: revoke the last API Token and its step reopens. The two-factor step is about the person looking, so two Members of one workspace can see it differently.

Dismissing

Owners and admins can dismiss the checklist for the whole workspace. The dismissal is the one thing persisted (a timestamp on the workspace) and it records a workspace.onboarding_dismissed Audit Event naming who dismissed it. Members see the checklist read-only. A member also does not see the API-token and webhook steps, because reading those lists is a permission a member does not hold.