Intempt iOS SDK API Documentation

Overview

The iOS SDK enables you to track user interactions within your iOS app and manage its configuration via the Intempt console.

The initialized iOS SDK automatically collects the following events with data-rich attributes:

Auto-Tracked Events

Event	Definition
Touch	Recorded when a user taps or touches a UI control, such as buttons, sliders, or any interactive elements.
View Screen	Captured every time a user views a screen within the app. Useful for tracking navigation and screen engagement.
Leave Screen	Logged when a user exits a screen. Helps understand user flows and potential interface issues.
Action	Triggered by an interaction like submitting a form or clicking a link. Useful for identifying effective CTAs.
App Install/Upgrade	Tracks app installations or upgrades with version and build details.
Start Session	Logs the start of a new user session.
End Session	Recorded after 5 minutes of inactivity, useful for session length analysis.

Following this guide, you can also track custom events and perform personalization campaigns and A/B experiments.

Requirements

iOS 13.0+

Xcode 11.0 or later

Installation

Create a Source

Go to Integrations → Sources.

Click Create Source.

Choose the iOS option.

Copy the snippet provided — you'll need it for SDK initialization.

Create the API Key

Refer to the API Keys section to generate a unique API key for authenticating the SDK.

Initialize the SDK

Integration using Swift Package Manager

Intempt fully supports Swift Package Manager.

Open your .xcodeproj.

Navigate to File → Add Packages…

Paste the URL:


[https://github.com/intempt/intempt-intemptios](https://github.com/intempt/intempt-intemptios)

Choose the master branch.

Integration as a Manual Framework

Download the SDK repository as a ZIP file.

Locate Intempt.xcframework.

Copy it into your project directory.

Drag & drop Intempt.xcframework into your iOS app in Xcode.

Set Embed & Sign:

Go to Target → Build Phases

Expand Embed Frameworks

Add Intempt.xcframework

Go to Target → General → Frameworks, Libraries, and Embedded Content

Ensure Embed & Sign is selected.

After these steps, the project should compile without errors.

Initialization — Swift

Works with Xcode 11.3+

SceneDelegate.swift

ViewController.swift

Initialization — Objective-C

AppDelegate.m (Xcode 11.3+)

ViewController.m

Authorize SDK

Copy the following from the Intempt console:

Source ID

Project ID

Organization ID

API Key

Use them in your initialization parameters.

Supported Event Types

Auto-Tracked Events

Touch
View Screen
Leave Screen
Action
App Install/Upgrade
Start Session
End Session

Custom Events

Custom events are actions you define inside your code.

Once tracked, custom events appear automatically in the Events list of the Intempt console.

SDK Methods

IntemptConfig Parameters

Parameter	Type	Purpose
queueEnabled	BOOL	Enables batching events. Default: YES
itemsInQueue	Int	Number of events needed before a batch is sent. Default: 5
timeBuffer	TimeInterval	Interval in seconds to send events periodically. Default: 5
isInputTextCaptureDisabled	BOOL	Prevents capturing text inputs. Default: NO
initialDelay	TimeInterval	Delay before sending events. Default: 0.2

Track

Record

identify()

Identify with attributes

group()

Group with attributes

Accept

Reject

Alias

Product Events

productView

productAdd

productOrdered

Utility Methods

isUserOptIn

logout

getProfileId

getSessionId

disableTextInput

optOut

optIn

enableLogging

disableLogging

validateTrackingSession

endTrackingSession

startTrackingSession

Experiments & Personalization

chooseExperiments (byNames)

chooseExperiments (byGroups)

choosePersonalizations (byNames)

choosePersonalizations (byGroups)

Recommendation API

Troubleshooting

Framework built for unsupported architectures

Set:
Target → Build Settings → Validate Workspace = NO
Toggle YES → NO if needed.

App Store architecture errors

Add a Run Script Phase and include the provided lipo-cleaning script.

dyld: Library not loaded

Ensure:
Intempt.xcframework = Embed & Sign

"Intempt no such module"

Delete the framework, clean DerivedData, re-add Intempt.xcframework.

No data visible

iOS SDK batches events periodically — allow a few seconds.

Events taking too long to send

Check:

timeBuffer

itemsInQueue

Field Type Validation

Ensure event fields match the schema types.

Example:
String expected:

Accepted:
const event = { name: "John Doe" }

Rejected:
const event = { name: { first: "John", last: "Doe" } }

Adding new fields is supported — existing fields must remain same type.

iOS SDK

Intempt iOS SDK API Documentation#

Overview#

Auto-Tracked Events#

Requirements#

Installation#

Create a Source#

Create the API Key#

Initialize the SDK#

Integration using Swift Package Manager#

Integration as a Manual Framework#

Initialization — Swift#

SceneDelegate.swift#

ViewController.swift#

Initialization — Objective-C#

AppDelegate.m (Xcode 11.3+)#

ViewController.m#

Authorize SDK#

Supported Event Types#

Auto-Tracked Events#

Custom Events#

SDK Methods#

IntemptConfig Parameters#

Track#

Record#

identify()#

Identify with attributes#

group()#

Group with attributes#

Consent#

Accept#

Reject#

Category Consent#

Alias#

Product Events#

productView#

productAdd#

productOrdered#

Utility Methods#

isUserOptIn#

logout#

getProfileId#

getSessionId#

disableTextInput#

optOut#

optIn#

enableLogging#

disableLogging#

validateTrackingSession#

endTrackingSession#

startTrackingSession#

Experiments & Personalization#

chooseExperiments (byNames)#

chooseExperiments (byGroups)#

choosePersonalizations (byNames)#

choosePersonalizations (byGroups)#

Recommendation API#

Troubleshooting#

Framework built for unsupported architectures#

App Store architecture errors#

dyld: Library not loaded#

"Intempt no such module"#

No data visible#

Events taking too long to send#

Field Type Validation#

Intempt iOS SDK API Documentation

Overview

Auto-Tracked Events

Requirements

Installation

Create a Source

Create the API Key

Initialize the SDK

Integration using Swift Package Manager

Integration as a Manual Framework

Initialization — Swift

SceneDelegate.swift

ViewController.swift

Initialization — Objective-C

AppDelegate.m (Xcode 11.3+)

ViewController.m

Authorize SDK

Supported Event Types

Auto-Tracked Events

Custom Events

SDK Methods

IntemptConfig Parameters

Track

Record

identify()

Identify with attributes

group()

Group with attributes

Consent

Accept

Reject

Category Consent

Alias

Product Events

productView

productAdd

productOrdered

Utility Methods

isUserOptIn

logout

getProfileId

getSessionId

disableTextInput

optOut

optIn

enableLogging

disableLogging

validateTrackingSession

endTrackingSession

startTrackingSession

Experiments & Personalization

chooseExperiments (byNames)

chooseExperiments (byGroups)

choosePersonalizations (byNames)

choosePersonalizations (byGroups)

Recommendation API

Troubleshooting

Framework built for unsupported architectures

App Store architecture errors

dyld: Library not loaded

"Intempt no such module"

No data visible

Events taking too long to send

Field Type Validation