Quickstart

Create an app

Sign in to the FlwKit dashboard and create a new app. Your API key is shown once at creation — copy it now and store it securely.

Install the SDK

Add the FlwKit iOS SDK via Swift Package Manager.

1. In Xcode, go to File → Add Package Dependencies...
2. Enter the repository URL: https://github.com/FlwKit/flwkit_ios.git
3. Select Up to Next Major Version from 0.1.0 and add to your target.

See Installation for a Package.swift snippet and full requirements.

Configure the SDK

Call FlwKit.configure() once at app startup before any view is shown.

import SwiftUI
import FlwKit_ios
 
@main
struct MyApp: App {
    init() {
        FlwKit.configure(apiKey: "your-api-key")
    }
 
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Build your first flow

In the dashboard, go to Flows → New flow. Add at least a Header block and a CTA block with action set to complete, then click Publish. Set the flow as Active so the SDK serves it.

Display the flow

Add FlwKitFlowView anywhere in your SwiftUI view hierarchy. The active flow is fetched and rendered automatically.

import SwiftUI
import FlwKit_ios
 
struct OnboardingView: View {
    var body: some View {
        FlwKitFlowView { result in
            print("Completed: \(result.flowId)")
            print("Answers: \(result.answers)")
            // Navigate to your main screen
        }
    }
}