Android Setup
Prerequisites
Configure your Android push settings in the Userpilot Settings Studio before setting up push notifications in your app. To obtain the required keys and configuration details, refer to the Android Push Notification Guide.Setup
This guide assumes this is the first time you’re adding push notification code to your project using Google services (Firebase Cloud Messaging). If your project is already configured for push, proceed to Step 2. Step 1. Add Firebase Follow the steps in the official Google documentation on How to add Firebase to your project. Step 2. Request Notifications Permission Starting from Android 13 (API level 33), apps must explicitly request thePOST_NOTIFICATIONS permission to display push notifications.
The Userpilot Flutter plugin automatically requests push notifications permission on its own.
Step 3. Add the Userpilot Firebase Messaging Service
Firebase connects to your app through a <service>. Go to your Manifest file under example -> android -> app -> manifest and add:
FirebaseMessagingService, you can leave it as is and instead plug in UserpilotFirebaseMessagingService to your service class.
intent-filter in your app’s **entry **Activity under example -> android -> app -> manifest .
This configuration enables deep linking based on a custom scheme defined in your app.
Define the Deep Link Scheme In your userpilot.xml configuration file, you should have defined a value for userpilot_push_notification , check Step 5.
Update Manifest file to include the intent-filter as below. Make sure to set host="sdk" .
<resources> values. To change them, create a file under res/values under example -> android -> app and set the desired values.
iOS Setup
Prerequisites
Configure your iOS push settings in the Userpilot Settings Studio before setting up push notifications in your app. To obtain the required keys and configuration details, refer to the iOS Push Notification Guide.Enabling Push Notification Capabilities
In Xcode, navigate to the Signing & Capabilities section of your main app target and add the Push Notifications capability.Configuration
The Userpilot iOS SDK supports receiving push notifications so you can reach your users whenever the moment is right. There are two options for configuring push notifications: automatic or manual. Automatic configuration is the quickest and simplest way to configure push notifications and is recommended for most customers.Automatic Configuration
Automatic configuration takes advantage of swizzling to automatically provide the necessary implementations of the requiredUIApplicationDelegate and UNUserNotificationCenterDelegate methods.
To enable automatic configuration, call Userpilot.enableAutomaticPushConfig() from UIApplicationDelegate.application(_:didFinishLaunchingWithOptions:) inside example -> ios -> AppDelegate.swift.
Manual Configuration
Step 1. Enable Push CapabilitiesStep 2. Register for Push Notifications
Step 3. Set Push Token for Userpilot
Step 4. Enable Push Response Handling
Step 5. Configure Foreground Handling Full source code: