Onboarding Flows

Onboarding flows define step-by-step experiences for new users. Track completion rates and optimize your first-time user experience.

How it works

Admin creates an onboarding flow with ordered steps
The client SDK fetches the active flow for the user
As users complete steps, progress is tracked
Analytics show start, completion, and skip rates per flow

MCP tools

Tool	Description
`amba_create_onboarding_flow`	Create an onboarding flow with steps
`amba_get_onboarding_stats`	Get completion statistics

Example

Agent: "Create a welcome onboarding flow"

amba_create_onboarding_flow({
  project_id: "proj_xxx",
  name: "Welcome Flow",
  steps: [
    { id: "welcome", title: "Welcome", description: "Welcome to the app!", type: "welcome" },
    { id: "notifications", title: "Stay Updated", description: "Enable push notifications", type: "permission", config: { permission: "push" } },
    { id: "personalize", title: "Personalize", description: "Tell us about yourself", type: "personalization" },
    { id: "tour", title: "Quick Tour", description: "See what you can do", type: "feature_tour" }
  ]
})

Client API reference

Method	Path	Description
`GET`	`/client/onboarding/flows`	Get active onboarding flows
`POST`	`/client/onboarding/flows/:id/complete-step`	Mark a step as completed
`POST`	`/client/onboarding/flows/:id/skip`	Skip the flow entirely

Database tables

Table	Purpose
`onboarding_flows`	Flow definitions with ordered steps
`user_onboarding_progress`	Per-user progress tracking

How it works

MCP tools

Example

Client API reference

Database tables

On this page