Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flow-board.co/llms.txt

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

If you want the full setup from Studio to SDK initialization, start with Quick start. This page assumes Flowboard is already installed and initialized in your app.
Flowboard currently exposes two ways to display a flow inside your app. The SDK method names still use launchOnboarding, but they open any published Flowboard flow. For React Native and Expo, the examples below also assume your app is already wrapped in FlowboardProvider.

​
The two launch modes

MethodWhat it doesBest for
launchOnboarding()Opens the default published flow resolved for the current app, device, and audience.Normal production entry points where Studio should decide which flow to show.
launchOnboardingById(...)Fetches and opens one specific flow by ID.QA, previews, campaigns, or app code that must always open one exact flow.
launchOnboarding() opens the default published flow for the current app context. Depending on the SDK, that flow may be resolved during initialization or fetched when you launch it. launchOnboardingById(...) fetches the requested flow directly when you launch it.
React Native, Expo, Flutter, and native iOS expose both launch modes directly today. The native Android SDK is still in beta, so the Android example below focuses on the default resolved launcher.

​
1. Launch the default resolved flow

Use this when Flowboard should decide which published flow to show based on your app identifiers, targeting rules, and rollout logic. 
import { Button } from 'react-native';
import { Flowboard } from 'flowboard-react';

async function openDefaultFlow() {
  await Flowboard.launchOnboarding({
    onOnboardEnd: (formData) => {
      console.log('Flow finished:', formData);
    },
  });
}

export function LaunchDefaultFlowButton() {
  return <Button title="Open Flowboard flow" onPress={openDefaultFlow} />;
}
This is the best default for most apps because:
  • You do not hardcode a flow ID in the app
  • Studio can swap the live flow without an app release
  • Audience targeting and rollout rules stay in Flowboard

​
2. Launch a specific flow by ID

Use this when your app should always open one exact flow, such as a QA entry point, a preview button, a targeted campaign, or an internal test surface. 
import { Button } from 'react-native';
import { Flowboard } from 'flowboard-react';

const FLOW_ID = 'YOUR_FLOW_ID';

async function openSpecificFlow() {
  await Flowboard.launchOnboardingById(FLOW_ID, {
    locale: 'en_US',
    version: 'live',
    onOnboardEnd: (formData) => {
      console.log('Pinned flow finished:', formData);
    },
  });
}

export function LaunchSpecificFlowButton() {
  return <Button title="Open specific flow" onPress={openSpecificFlow} />;
}
This is the right choice when:
  • You already know the exact flow ID to open
  • You need a fixed QA or preview route in the app
  • You want to choose live or draft explicitly during testing

​
Key differences

  • launchOnboarding() lets Flowboard resolve the live experience for the current user and app context.
  • launchOnboardingById(...) skips that resolution step and requests one exact flow directly.
  • launchOnboarding() is usually the best production default.
  • launchOnboardingById(...) is better for controlled entry points, testing, and tooling.