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 Project?

A project in OnboardSync represents a single mobile application. Each project contains all the onboarding flows, themes, and configurations for that specific app.

​
Key Concepts

​
Project Structure

Each project consists of:
  • Flows: Different onboarding experiences (e.g., default flow, premium user flow)
  • Themes: Visual styling that can be applied to flows
  • Analytics: Usage data and conversion metrics
  • Settings: API keys and configuration options

​
Project Credentials

Every project has two key identifiers:
  1. Project ID: A unique identifier for your project
  2. Secret Key: A client-safe key for SDK authentication
// Flutter
await OnboardSync.showOnboarding(
  context,
  projectId: 'your-project-id',
  secretKey: 'your-secret-key'
);

// React Native
<OnboardSyncComponent
  projectId="your-project-id"
  secretKey="your-secret-key"
/>

// Swift
let config = OnboardSyncConfig(
  projectId: "your-project-id",
  secretKey: "your-secret-key"
)
Both the project ID and secret key are safe to include in mobile apps. They only provide read access to your onboarding configuration.

​
Creating a Project

  1. Navigate to the OnboardSync Dashboard
  2. Click “New Project”
  3. Enter your project details:
    • Name: A descriptive name for your app
    • Description: Optional details about the project
    • Platform: Select your target platforms (iOS, Android, or both)

​
Project Settings

​
API Configuration

Each project provides:
  • Project ID: Unique identifier for your project
  • Secret Key: Authentication key for mobile SDKs (found in API Keys section)
  • API Endpoint: Base URL for API requests (defaults to https://onboardsync.vercel.app)
  • Analytics: Real-time tracking of user interactions

​
Flow Management

Within each project, you can:
  • Create multiple onboarding flows
  • Set up A/B tests with different weightings
  • Control which users see which flows
  • Track performance of each flow variant

​
Device Tracking

OnboardSync automatically:
  • Generates unique device IDs for consistent user experience
  • Tracks completion status per device
  • Ensures users don’t see onboarding twice
  • Maintains flow assignment for A/B testing

​
Best Practices

Create a separate project for each mobile application. Don’t try to share projects between different apps.
Name your projects clearly (e.g., “MyApp iOS Production” instead of “Project 1”).
Consider creating separate projects for development and production environments.

​
Managing Multiple Projects

If you have multiple apps or environments, you can:
  • Switch between projects in the dashboard
  • Use different project IDs in your SDK configuration
  • Set up team members with access to specific projects

Flows

Learn about creating onboarding flows

Analytics

Track project performance