Module
Multi-step onboarding flows with progress tracking, completion webhooks, and bot protection built in.
Everything you need to run structured onboarding flows via API.
Define onboarding flows with arbitrary JSON steps. Each step collects data and advances the session.
Track currentStep, accumulated payload, and completion status per session.
Fire onboarding.completed events to your webhook endpoints when a session finishes.
Bot protection on the first step via Cloudflare Turnstile. Skippable in development.
Hidden field on step 0 silently discards bot sessions.
Export all sessions with completion status, payloads, and timestamps.
Any workflow that collects data step-by-step can use NexusKit Onboarding.
Guide new users through account setup, preferences, and first steps in your product.
Multi-step forms that collect progressively more detail before routing to sales.
Structured workflows for new hire setup, document collection, and training progress.
Step-by-step identity verification flows with document upload and review stages.
Create a flow, start a session, and advance step by step.
POST /v1/onboarding/flows
{
"name": "New User Setup",
"steps": [
{ "type": "info", "label": { "en": "Welcome" } },
{ "type": "form", "label": { "en": "Your details" } },
{ "type": "confirm", "label": { "en": "Review" } }
]
}POST /v1/public/onboarding/flows/:flowId/sessions
{
"locale": "en",
"turnstileToken": "..."
}PATCH /v1/public/onboarding/sessions/:sessionId
{
"payload": { "name": "Jane", "email": "[email protected]" }
}
// Response: { "currentStep": 1, "completedAt": null }When currentStep reaches the total steps, the session is marked complete and a webhook fires.
Define a flow with a JSON steps array. Each PATCH call to the public API advances the session by one step, merging the step payload. When currentStep >= steps.length, the session is marked complete.
Yes, within fair-use limits: 5,000 onboarding sessions per month, 120 requests per minute.
Yes. Configure webhook endpoints in the dashboard. The onboarding.completed event fires with the full session payload when a flow finishes.
Turnstile is only verified on step 0 (session creation). Subsequent steps do not require captcha.
Yes. Each step has its own payload structure. The session accumulates all step payloads into a single JSON object.
Start free. No credit card. Set up your first flow in minutes.