Quickstart

Start integrating OnboardSync in under 5 minutes

Setup your first onboarding flow

Follow these steps to get OnboardSync running in your mobile app.

1. Create an Account

   Sign up for OnboardSync at app.onboardsync.com and create your first project.

2. Design Your Flow

   Use the visual editor to create your onboarding screens. Choose from pre-built templates or start from scratch.

3. Install SDK

   Add the OnboardSync SDK to your mobile app. Choose your platform below.

4. Initialize & Display

   Initialize the SDK with your project credentials and display the onboarding flow.

Installation

Flutter

flutter pub add onboardsync

Basic Implementation

Flutter

import 'package:onboardsync/onboardsync.dart';
import 'package:flutter/material.dart';

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: OnboardingScreen(),
    );
  }
}

class OnboardingScreen extends StatefulWidget {
  @override
  _OnboardingScreenState createState() => _OnboardingScreenState();
}

class _OnboardingScreenState extends State<OnboardingScreen> {
  @override
  void initState() {
    super.initState();
    _showOnboarding();
  }

  Future<void> _showOnboarding() async {
    try {
      // Show onboarding
      await OnboardSync.showOnboarding(
        context,
        projectId: 'your-project-id',
        secretKey: 'your-secret-key', // Get from dashboard
      );
      
      // Navigate to main app after completion
      Navigator.of(context).pushReplacement(
        MaterialPageRoute(builder: (_) => MainApp()),
      );
    } catch (e) {
      // Handle error - proceed to app
      Navigator.of(context).pushReplacement(
        MaterialPageRoute(builder: (_) => MainApp()),
      );
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: CircularProgressIndicator(),
      ),
    );
  }
}

Configuration Options

Each SDK requires the following configuration:

{
  projectId: string,        // Your project ID from the dashboard
  secretKey: string,        // Your secret key from the dashboard
  domain?: string,          // Optional: Custom domain (defaults to production)
  testingEnabled?: boolean, // Optional: Show onboarding every time (for testing)
}

Getting your credentials: Log in to the OnboardSync dashboard, navigate to your project settings, and find your project ID and secret key in the API Keys section.

What’s Next?

Core Concepts

Learn about projects, flows, and screens

SDK Documentation

Detailed guides for each platform

API Reference

Explore the REST API

Analytics

Track user behavior and conversions

Need Help?

Having issues? Check our troubleshooting guide or contact support at [e-mail]