Features

This chapter covers the core features and capabilities of Onboarding Flow.

Features

• Multi-step flows — Define ordered onboarding steps (form, choice, info, action types)
• Progressive profiling — Collect user data across multiple steps without overwhelming them
• Conditional steps — Show/hide steps based on user attributes (role, plan, etc.)
• Skip support — Optional steps can be skipped; required steps must be completed
• Completion tracking — Percentage-based progress tracking per user
• Welcome emails — HTML email templates with step overview and CTA buttons
• Completion emails — Congratulations email with summary of completed/skipped steps
• Template engine — Built-in {{variable}} and {{#if condition}} template rendering
• JSON persistence — Save/load flow definitions and user progress

Requirements

• Python 3.10+
• No external dependencies (stdlib only)

Quick Start

Follow this guide to get Onboarding Flow up and running in your environment.

Quick Start

# Start with demo flow
python src/main.py --init-demo

# Custom port
python src/main.py --port 8002

Then try the API:

# List available flows
curl http://localhost:8002/api/flows

# Start onboarding for a user
curl -X POST http://localhost:8002/api/flows/<flow_id>/start \
  -H "Content-Type: application/json" \
  -d '{"user_id": "user_123", "context": {"role": "admin"}}'

# Complete a step
curl -X POST http://localhost:8002/api/flows/<flow_id>/complete-step \
  -H "Content-Type: application/json" \
  -d '{"user_id": "user_123", "step_id": "profile", "data": {"company": "Acme Corp"}}'

# Check progress
curl http://localhost:8002/api/flows/<flow_id>/progress/user_123

API Endpoints