Apple SDK

Apple SDK

The Intempt Apple SDK tracks user interactions in your app, resolves experiments and recommendations, records consent, and registers devices for push notifications sent from Intempt journeys.

One package covers every Apple platform. The page is still called the iOS SDK in most places because that is where nearly all traffic comes from, but nothing here is iOS-only except the autocapture hooks, which need UIKit.

Requirements

The iOS floor is 15.0. A target still set to 14.x fails to build against the SDK with compiling for iOS 14.0, but module 'Intempt' has a minimum deployment target of iOS 15.0.

Installation

Swift Package Manager

dependencies: [
    .package(url: "https://github.com/intempt/intempt-swift.git", from: "0.1.0")
]

In Xcode: File → Add Package Dependencies, enter https://github.com/intempt/intempt-swift.git, and choose Up to Next Major Version from 0.1.0.

CocoaPods

pod 'Intempt', '~> 0.1.0'

A cross-platform wrapper depends on the same pod:

s.dependency 'Intempt', '0.1.0'

Setup

Collect these from the Intempt console under Integrations → Sources, on the Apple source you are sending to:

Initialization

import Intempt

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {

        do {
            let intempt = try IntemptInstance.initialize(
                apiKey: "yourPrefix.yourSecret",
                orgId: "your-org",
                projectId: "your-project",
                sourceId: "your-source-id"
            )

            intempt.autocapture.configure(.all)
            intempt.autocapture.start()
        } catch {
            // Blank identifiers and malformed keys throw here rather than failing silently.
            print("Intempt initialization failed: \(error)")
        }

        return true
    }
}

initialize is declared on IntemptInstance. The Intempt enum is a namespace for constants (sdkVersion, defaultFeedFields), not an entry point.

It throws rather than logging and continuing: a blank orgId is an integration error, and posting to a malformed URL forever is not a recovery. Calling it twice with the same instance name returns the existing instance instead of building a second one.

Reach the same instance later from anywhere:

guard let intempt = IntemptInstance.mainInstance() else { return }

SwiftUI

There is no AppDelegate in a pure SwiftUI lifecycle, so initialize from the App initializer and keep the instance yourself:

@main
struct MyApp: App {
    init() {
        _ = try? IntemptInstance.initialize(
            apiKey: "yourPrefix.yourSecret",
            orgId: "your-org",
            projectId: "your-project",
            sourceId: "your-source-id"
        )
    }

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

Autocapture hooks UIViewController, so a pure SwiftUI view hierarchy produces few screen events. Track screens explicitly with track(eventTitle:) in onAppear.

Capture

track()

Records a custom event.

intempt.track(eventTitle: "flight-booking", data: [
    "flightId": 1,
    "bookingDate": "2024-01-29",
    "bookingStatus": "booked",
])

record()

One call that carries user and account context together.

intempt.record(
    eventTitle: "flight-booking",
    userId: "xyz@intempt.com",
    accountId: "intempt.com",
    data: ["flightId": 1],
    userAttributes: ["city": "New York", "country": "USA"],
    accountAttributes: ["mtuCount": "1000+"]
)

Every tracking method returns @discardableResult Bool — false means the event was not queued, most often because the user has opted out.

Commerce

intempt.productView(productId: "2369423736890")
intempt.productAdd(productId: "2369423736890", quantity: 2)
intempt.productOrdered(products: [
    (productId: "2369423736890", quantity: 2),
    (productId: "2369423736891", quantity: 1),
])

Consent

intempt.consent(action: .accept, validUntil: 31_536_000)
intempt.consent(action: .reject, validUntil: 0, category: "marketing")

.reject enforces the decision rather than only recording it: collection stops and queued events are purged, the same gate as optOut().

The withdrawal record itself is still transmitted, even while opted out. It goes to its own endpoint, unbatched — it is the evidence the user objected, and dropping it would leave the objection recorded nowhere.

Identity and lifecycle

intempt.identify(userId: "xyz@intempt.com", userAttributes: [
    "city": "New York",
    "plan": "pro",
])

intempt.group(accountId: "intempt.com", accountAttributes: [
    "mtuCount": "1000+",
])

intempt.alias(userId: "xyz@intempt.com", anotherUserId: "legacy-id-42")

group takes accountAttributes. The Objective-C SDK called this parameter userAttributes while sending an account, which is worth knowing if you are porting old code across.

Read the current identity back:

Opt in / out

optOut() discards the queue as well as stopping collection. If you need the events already gathered, flush() before opting out.

Delivery

Events are batched and flushed on a timer. flush { sent in } is the only way to observe delivery — the tracking calls return whether an event was queued, not whether it arrived.

Personalization

intempt.products(feedId: "9", count: 4, productId: "2369423736890") { result in
    switch result {
    case .success(let products): render(products)
    case .failure(let error):    print(error)
    }
}

fields: defaults to Intempt.defaultFeedFields on purpose. An unfielded request returns every catalog column, including raw ML embedding vectors — measured at 443 times the payload size. Widen it deliberately, never by omission.

Automatic events

Two mechanisms produce events without call sites, and they are configured differently. Mixing them up is the usual reason an expected event never arrives. This is the first; Autocapture is the second.

Lifecycle events. A settable property, no start call, and sessions are already on.

intempt.automaticEvents = AutomaticEventOptions(
    sessions: true,
    versionChanges: true,
    appStateChanges: true
)

Autocapture

UI interactions. Needs configure(_:) and start(), and everything is off until you call them, because it works by swizzling UIKit.

Autocapture is iOS and tvOS only; it needs UIKit.

taps and rawTouches are deliberately separate. A button press already produces an Action, so counting it as a Touch as well would double-count every press.

Push notifications

Intempt sends push straight to APNs. There is no Firebase or FCM dependency at any layer, on the device or on the server.

1. Register the device

func application(
    _ application: UIApplication,
    didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data
) {
    IntemptInstance.mainInstance()?.setPushToken(deviceToken)
}

The token is sent as a user attribute named apns_token_<sourceId> on an App Install/Upgrade event. The per-source name is deliberate: one device can be registered against several sources, and a flat name would collide.

2. Attribute opens and receipts

// UNUserNotificationCenterDelegate — the user tapped the notification
func userNotificationCenter(
    _ center: UNUserNotificationCenter,
    didReceive response: UNNotificationResponse,
    withCompletionHandler completionHandler: @escaping () -> Void
) {
    IntemptInstance.mainInstance()?.trackPushOpen(response.notification.request.content.userInfo)
    completionHandler()
}

// Silent or foreground arrival
func application(
    _ application: UIApplication,
    didReceiveRemoteNotification userInfo: [AnyHashable: Any],
    fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void
) {
    IntemptInstance.mainInstance()?.trackPushReceived(userInfo)
    completionHandler(.newData)
}

Only the campaign identifier and the developer-authored title are read from the payload. The notification body is never collected.

3. Configure the credentials in Intempt

Push is delivered with a token-based APNs key (.p8), not a certificate — one key works for every app in your team and does not expire annually.

Two mistakes account for most failures, and Apple reports both as the same opaque error hours later:

• Pasting the key filename into Key ID. AuthKey_ABC1234567.p8 contains the right value but is not it. Intempt rejects this at save time.
• Wrong environment. A token minted by a development build is not valid against production APNs, and the resulting 400 BadDeviceToken is indistinguishable from a malformed token. Match the Sandbox toggle to how the build was signed.

4. Send from a journey

Add the Apple push destination to a journey. It resolves each profile's apns_token_<sourceId> attribute, so a device only becomes reachable after the app has called setPushToken at least once and the event has flushed.

Configuration reference

Everything configurable, and where it lives. Unlike the server SDKs there is no options object — initialize takes credentials only, and behaviour is set on the instance afterwards.

let intempt = try IntemptInstance.initialize(
    apiKey: "yourPrefix.yourSecret",
    orgId: "your-org",
    projectId: "your-project",
    sourceId: "your-source-id")

intempt.flushInterval = 30
intempt.automaticEvents = AutomaticEventOptions(sessions: true, versionChanges: true)
intempt.autocapture.configure(.all)
intempt.autocapture.start()

Logging

Off by default. Nothing is written to the console unless you ask for it.

IntemptLogger.shared.addLogging(IntemptPrintLogger())
IntemptLogger.shared.enableAllLevels()          // or .enable(.warning)

Levels are .debug, .info, .warning, .error. The logger never writes API keys or event bodies.

Queue limits

Privacy manifest

The SDK ships PrivacyInfo.xcprivacy inside its bundle, which Apple requires of a third-party SDK. You do not need to add one for Intempt — but you do need to account for what it declares when you fill in your own App Store privacy answers.

NSPrivacyTracking is false because nothing here joins a user across other companies' apps. If your app links Intempt data to a third-party advertising identifier, that is your declaration to make, not this one.

Property types

Event and attribute values conform to IntemptType: String, Int, UInt, Double, Float, Bool, Date, URL, NSNull, NSNumber, and arrays or dictionaries of the same, nested to any depth.

Values that cannot survive the wire — NaN, infinity — are rejected at the call boundary rather than serialized as the string "nan".

Data on disk

Events are queued in SQLite (WAL mode) under Library/, excluded from iCloud and iTunes backup, with data protection set to COMPLETEUNTILFIRSTUSERAUTHENTICATION so a background flush cannot hang on a locked screen.

The queue is capped at 5,000 events; beyond that the oldest are evicted, so an offline device cannot fill the user's disk. A batch is deleted only after the server acknowledges it — never before the request, and never as a blanket delete.

Errors and troubleshooting

Migrating from the Objective-C SDK

Data types are unchanged: [String: Any] dictionaries become [String: IntemptType], which accepts the same values with compile-time checking.