Set Up Client Integration
Follow this step-by-step process to integrate ContextPush with your iOS app.
Create a License Key & Install the SDK
Check out Getting Started for details on how to create your license key and install the SDK.
Enable ContextPush
In your AppDelegate or similar in the applicationDidFinishLaunchingWithOptions or equivalent call ContextPush.applicationDidFinishLaunchingWithOptions(). If everything worked you should see "[ContextSDK] Successfully scheduled next check for ContextPush."
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Your existing app startup code
ContextPush.applicationDidFinishLaunchingWithOptions()
}Understanding Background Wake-Up Behavior
Important: ContextPush uses background processing and silent push notifications to wake your app periodically in the background. This allows the SDK to assess the user's real-world context for optimal notification timing.
When ContextPush wakes your app in the background, iOS may call application(_:didFinishLaunchingWithOptions:) while your app is not in the foreground. This can have side effects if your app logic assumes this method only runs when the app is being launched by the user.
Recommended Approach: Use Lifecycle Notifications
The recommended way to handle foreground-specific logic is to use UIScene lifecycle methods or lifecycle notifications instead of checking the application state manually:
For apps using UIScene, implement sceneDidBecomeActive(_:) in your UISceneDelegate:
func sceneDidBecomeActive(_ scene: UIScene) {
// This is called when your app enters the foreground
// Place foreground-specific initialization code here
}For apps not using UIScene, observe UIApplication.didBecomeActiveNotification:
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Your existing app startup code
ContextPush.applicationDidFinishLaunchingWithOptions()
// Observe when the app becomes active
NotificationCenter.default.addObserver(
self,
selector: #selector(applicationDidBecomeActive),
name: UIApplication.didBecomeActiveNotification,
object: nil
)
return true
}
@objc private func applicationDidBecomeActive() {
// This is called when your app enters the foreground
// Place foreground-specific initialization code here
}If you need to check the application state manually in application(_:didFinishLaunchingWithOptions:):
Best Practices
Move foreground-specific initialization logic (e.g., presenting onboarding screens, tracking app launches, or showing promotional content) to lifecycle methods that are specifically called when the app enters the foreground.
Keep your
application(_:didFinishLaunchingWithOptions:)implementation lightweight and suitable for both foreground and background launches.Test your app's behavior when woken up in the background to ensure no unexpected UI presentations or crashes occur.
Provide User ID and Push Token
You need to register the user's device with a unique user ID and the device's push token. The user-id may be whatever you use to identify each user in your existing push notification system, e.g. an email address or a user ID from your database.
Set the user ID with ContextManager.setUserId(_:). The same user ID is shared across all ContextSDK products, so a single call associates the user with both your events and your push notifications. For push you then only need to provide the device token.
// Set the user ID once it is available, e.g. after the user signs in
ContextManager.setUserId(userId)
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
// Your existing code for handling device token registration
// Provide the device token to ContextSDK to enable push notifications
ContextPush.setDeviceToken(deviceToken)
}Handle Background Notifications
Ensure that your app can handle push notifications received while in the background by implementing the following method:
func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any],fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
// ContextSDK will process the notification if it is a valid ContextPush notification
// The completion handler will be automatically called if processed
if ContextPush.applicationDidReceiveRemoteNotification(userInfo, fetchCompletionHandler: completionHandler) {
return
}
// Handle other types of background notifications with your existing code, if needed
}Handle Notification Opens
Track when users open notifications to gather engagement metrics and improve user experience:
func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {
// Process the notification with ContextSDK to track open rates and user interactions
ContextPush.userNotificationCenterDidReceiveResponse(response)
// Your existing code
// Ensure completion handler is called to finalize notification handling
completionHandler()
}(Optional) Customize Notification Content
If you need to customize notifications beyond what ContextPush supports by default, you can provide a callback to modify the notification content before it is displayed. This is useful for:
Adding custom attachments or media
Modifying text based on app state or localization
Adding custom sounds
Setting additional notification properties
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Your existing app startup code
ContextPush.applicationDidFinishLaunchingWithOptions()
// Optional: Customize notification content before display
ContextPush.setNotificationContentCustomizer { content, userInfo in
// Example: Add a custom subtitle based on app state
content.subtitle = "Special offer just for you!"
// Example: Add a custom sound
content.sound = UNNotificationSound(named: UNNotificationSoundName("custom.caf"))
// Return the modified content (or a new UNNotificationContent)
return content
}
return true
}The callback receives:
content: TheUNMutableNotificationContentbuilt by ContextSDK from the push payloaduserInfo: The notification's user info dictionary, including your custom data
To disable customization, set the customizer to nil:
ContextPush.setNotificationContentCustomizer(nil)Test Your Setup
Visit your dashboard
Select Integrate Push in the menu
If this option is still not available to you, request access in Products Info → ContextPush
Upload your push certificate and fill in the necessary information
This will grant you access to your API token, which will be used later on.
You can either create a new push certificate for ContextPush, or use your existing one.
Test your push setup by using the Test Push Integration feature
Integrate With Your Push Notification Provider
You're now done integrating with the iOS app. Next, integrate with your existing push provider:
If you can't find your provider in this list, don't worry: you can integrate ContextPush with any provider, as long as it supports webhooks. Reach out to us to let us know which provider you use and we'll guide you through the integration steps.
Required: Notification Service Extension
ContextPush requires a Notification Service Extension to enable reporting when your app is not running.
Notification Service ExtensionLast updated
Was this helpful?