SDK Integration
π§Ύ Overview
SDK integration is required to enable push notifications and user tracking in your app.
It ensures that:
- Devices are registered correctly
- Push notifications can be delivered
- User activity (events) can be tracked
βοΈ Step 1: Register Your Mobile App
Before integrating the SDK, you need to add your mobile app in PushApp admin.
Navigate to:
Admin β Mobile Apps β Create
Configure Your App
For each app, you can add one or more platforms:
- Android
- iOS
Platform Setup Requirements
π± Android
Provide:
- Package name (Bundle ID)
- Firebase configuration:
- FCM Service Account (
service-account.jsonfile)
- FCM Service Account (
π iOS
Provide:
- Bundle ID
- Firebase configuration:
- FCM Service Account (
service-account.jsonfile)
- FCM Service Account (
- APNs configuration:
- Auth Key (
.p8file) - Key ID
- Team ID
- Auth Key (
π― What you get
Once setup is complete, you will receive a:
π Channel ID
This uniquely identifies your app and is required during SDK initialization.
π Step 2: Integrate SDK in Your App
After creating your app, integrate the PushApp SDK into your codebase.
During SDK initialization, you must pass:
- Channel ID
This links your app instance to PushApp.
π¦ Supported SDKs
Choose the SDK based on your platform:
Native SDKs
- iOS β View Documentation
- Android β View Documentation
Cross-Platform SDKs
- Flutter (iOS) β View Documentation
- Flutter (Android) β View Documentation
- React Native (iOS) β View Documentation
- React Native (Android) β View Documentation
π§ͺ Verify Integration
After integration:
- Install and open your app
- Ensure the device is registered
- Send a test push notification
π‘ Tip: If you receive the test notification, your integration is successful.
β οΈ Common Issues
β Notifications not received
β Check FCM / APNs configuration
β Device not registered
β Ensure SDK is initialized with correct Channel ID
β iOS notifications not working
β Verify APNs key, permissions, and certificates
π Related Features
- Push Notifications β Send campaigns
- Event Analytics β Track user activity
- Cohorts β Target users effectively
Once SDK integration is complete, youβre ready to start engaging your users π