​

Overview

FlockSDK-iOS enables seamless integration of Flock referral and rewards into your iOS applications. Effortlessly build powerful referral programs and track customer engagement in minutes.

• Identify and track users
• Present referral experiences as modals or full screen
• Handle events (close, success, invalid) in-app
• Officially supported by the Flock team

​

Requirements

• iOS 14.0 or later
• Swift 5.7 or later
• Xcode 14 or later

​

Installation

​

Swift Package Manager (Recommended)

1. Open your Xcode project.
2. Go to File > Add Packages…
3. Enter the repository URL: https://github.com/Flock-Solutions/FlockSDK-iOS.git
4. Select a version and add the package to your target.

.package(url: "https://github.com/Flock-Solutions/FlockSDK-iOS.git", from: "1.0.0")

​

Usage

​

1. Configure the SDK

Call Flock.initialize once, ideally in your AppDelegate or early in your app’s startup:

import FlockSDK

Flock.shared.initialize(
    publicAccessKey: "<YOUR_FLOCK_PUBLIC_KEY>",
    environment: .production // or .test
)

​

2. Identify Your User

Identify the current user (after login or at app start):

Flock.shared.identify(
    externalUserId: "<USER_ID_IN_YOUR_APP>",
    email: "user@example.com",
    name: "Alice Smith"
)

​

3. Show a Flock Page

​

Placement API (Recommended)

New: Use addPlacement(placementId:) instead of openPage(type:) for opening campaign pages. Each campaign page now has a unique placementId for more robust and future-proof integration.

A placement renders a Flock referral page within your app, making it easy to prompt users to share and participate in your referral program.

Flock.shared.addPlacement(
    placementId: "my_placement_id",
    onClose: { /* ... */ },
    onSuccess: { /* ... */ },
    onInvalid: { /* ... */ }
)

• The legacy openPage(type:) method is now deprecated and will be removed in a future release.
• Use the Placement API for all new integrations and update any usage of openPage(type:) to addPlacement(placementId:).

​

Legacy API (Deprecated)

Present the referral page anywhere in your app:

import FlockSDK

Flock.shared.openPage(
    type: "referrer", // Or "invitee" or "invitee?state=success"
    onClose: {
        // Called when closed
    },
    onSuccess: {
        // Called for success event
    },
    onInvalid: {
        // Called for invalid event
    }
)

​

Page Types

• referrer: Standard referral page for existing users
• invitee: For invited users
• invitee?state=success: Invitee success state

​

Event Callbacks

• onClose: Called when the page is closed
• onSuccess: Called on successful referral code submission
• onInvalid: Called for invalid referral code submission

​

Support

• Open an issue on GitHub
• Email: support@withflock.com

​

License

FlockSDK-iOS is released under the MIT License.

Happy referring 🚀