Overview

Preview: planned API

The iOS SDK is in development and not published yet. This page describes the API we are building so you can plan your integration. Package names, signatures and defaults may still change before the first release.

The RTN iOS SDK sends app events to the same pipeline as the Web SDK. Customers who use your app and your store share one profile, so the same live segments reach them by email, push, SMS and WhatsApp and sync to your ad audiences.

Requirements

iOS 15 or later, Swift 5.9+ (Xcode 15).

1. Install the package

Package.swift

dependencies: [
    .package(url: "https://github.com/rtn/rtn-ios", from: "0.1.0")
]

2. Initialize the SDK

Initialize once at launch, in your App initializer or application(_:didFinishLaunchingWithOptions:). Use the write key of a mobile app from Apps in the RTN dashboard.

import RTN

@main
struct ShopApp: App {
    init() {
        RTN.initialize(
            writeKey: "WRITE_KEY",
            configuration: RTNConfiguration(
                consent: .pending,
                trackLifecycleEvents: true,
                trackScreens: false
            )
        )
    }

    var body: some Scene {
        WindowGroup { ContentView() }
    }
}

Initialization is non-blocking. Calls made before the SDK is ready are queued and sent once it starts, and no public method throws.

3. Send your first event

RTN.track("newsletter_subscribed", properties: ["source": "footer"])

Events are batched on the device and survive restarts and offline periods. Open Events in the dashboard to see them arrive.

What the SDK collects automatically

With trackLifecycleEvents on (the default), the SDK records these events for you:

Event	When it is sent
`app_installed`	First launch after a fresh install, with install attribution
`app_updated`	First launch after the app version changes
`app_opened`	Every cold start and every return from the background
`app_backgrounded`	When the app moves to the background
`screen_viewed`	Automatic screen tracking, or each `screen` call
`deep_link_opened`	A direct or deferred deep link was handled
`push_opened`	`trackPushOpened` was called for a notification

Next steps

Events and identity: custom events, screens, ecommerce and known customers
Attribution and deep links: install attribution, deferred deep links and push
Consent and privacy: consent purposes and platform identifiers
API reference: every planned method

RequirementsCopy Anchor Link

1. Install the packageCopy Anchor Link

2. Initialize the SDKCopy Anchor Link

3. Send your first eventCopy Anchor Link

What the SDK collects automaticallyCopy Anchor Link