Skip to main content

Documentation Index

Fetch the complete documentation index at: https://muchadostudio.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

What is a Flow?

A flow is a sequence of screens that guide users through your app’s onboarding experience. Each flow can be customized with different content, themes, and targeting rules.

Flow Components

Screens

Each flow consists of one or more screens that users navigate through:
  • Welcome screens: Introduce your app’s value proposition
  • Permission screens: Request necessary permissions
  • Feature highlights: Showcase key functionality
  • Account setup: Guide users through registration

Themes

Flows inherit styling from themes, which control:
  • Colors (primary, secondary, background)
  • Typography
  • Button styles
  • Overall visual appearance
OnboardSync automatically handles navigation between screens:
  • Swipe gestures
  • Next/Previous buttons
  • Progress indicators
  • Skip options

Creating Flows

1

Navigate to Flows

In your project dashboard, click on “Flows” in the sidebar
2

Create New Flow

Click “Create Flow” and provide a name and description
3

Add Screens

Use the visual editor to add and customize screens
4

Configure Settings

Set up targeting rules and theme selection

Flow Types

Default Flow

Every project must have a default flow that serves as the fallback onboarding experience.
// The SDK automatically loads the default flow
await onboardSync.showOnboarding();

Targeted Flows

Create specialized flows for different user segments:
  • New users vs. returning users
  • Free vs. premium users
  • Geographic regions
  • Device types

A/B Testing

OnboardSync supports A/B testing to optimize your onboarding:
Pro tip: Start with 2-3 variations of your flow and gradually refine based on analytics data.

Setting Up A/B Tests

  1. Create multiple flows with variations
  2. Set targeting percentages (e.g., 50/50 split)
  3. Monitor performance in analytics
  4. Promote the winning variation

Test Variations

Common elements to test:
  • Number of screens
  • Content messaging
  • Visual design
  • Permission request timing
  • Call-to-action buttons

Flow Settings

Targeting Rules

Configure when and how flows are displayed:
  • User Properties: Target based on user attributes
  • Device Info: iOS vs Android, screen size, app version
  • Time-based: Show different flows at different times
  • Percentage Split: Distribute users across flows

Completion Behavior

Define what happens when users complete a flow:
  • Mark as completed (won’t show again)
  • Navigate to specific app screen
  • Trigger custom callbacks
const result = await onboardSync.showOnboarding();
if (result.completed) {
  // User completed the flow
  navigateToHome();
} else if (result.skipped) {
  // User skipped the flow
  handleSkip();
}

Best Practices

Limit flows to 3-5 screens. Users have short attention spans.
Don’t overwhelm users. Introduce features gradually.
Each screen should clearly communicate value to the user.
Continuously test and refine based on completion rates.

Flow Analytics

Track key metrics for each flow:
  • Start Rate: How many users begin the flow
  • Completion Rate: Percentage who finish
  • Drop-off Points: Where users abandon
  • Time to Complete: Average duration

Analytics

Monitor flow performance

API Reference

Flows API documentation