Supporting Re-engagement Tracking using Push Notifications

Singular supports push notification tracking to enhance re-engagement measurement. By integrating Firebase Cloud Messaging (FCM) with the Singular SDK, you can track users who interact with push notifications and attribute them accordingly.

To ensure accurate tracking, follow the implementation guidelines below and make sure that notification data is correctly passed to the Singular SDK.

Step 1: Setting Up Firebase Push Notifications in Flutter

First, integrate Firebase into your Flutter app to handle push notifications. Follow these steps:

1. Add Dependencies Add the required packages to your pubspec.yaml
   yaml

   dependencies:
     firebase_core: ^2.24.2
     firebase_messaging: ^14.7.10

2. Configure Firebase
   • Android: Place google-services.json in android/app/ and update Gradle files (see ).
   • iOS: Place GoogleService-Info.plist in the Xcode Runner folder and update Podfile with Firebase pods.
3. Initialize Firebase in Flutter Update your main.dart:
   dart

   import 'package:firebase_core/firebase_core.dart';
   import 'package:firebase_messaging/firebase_messaging.dart';
   
   Future<void> _firebaseMessagingBackgroundHandler(RemoteMessage message) async {
     await Firebase.initializeApp();
     print("Background message: ${message.messageId}");
   }
   
   void main() async {
     WidgetsFlutterBinding.ensureInitialized();
     await Firebase.initializeApp();
     FirebaseMessaging.onBackgroundMessage(_firebaseMessagingBackgroundHandler);
     runApp(MyApp());
   }

Step 2: Handling Push Notifications in Flutter

When your app receives a push notification from Firebase, you need to capture the notification data and prepare it for Singular. Here's how to handle notifications in different app states:

Android

• Foreground: Handle notifications directly in Dart.
• Background/Terminated: Interface with the native Android layer.

Update your Dart code:

class _MyAppState extends State<MyApp> {
  final FirebaseMessaging _firebaseMessaging = FirebaseMessaging.instance;

  @override
  void initState() {
    super.initState();

    // Request permission
    _firebaseMessaging.requestPermission();

    // Foreground notifications
    FirebaseMessaging.onMessage.listen((RemoteMessage message) {
      print('Foreground message: ${message.messageId}');
      String title = message.notification?.title ?? '';
      String body = message.notification?.body ?? '';
      Map<String, dynamic> data = message.data;

      // Process notification for Singular (foreground)
      _processNotificationForSingular(title, body, data);
    });

    // Background/Opened from notification
    FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {
      print('Message opened: ${message.messageId}');
      _processNotificationForSingular(
        message.notification?.title ?? '',
        message.notification?.body ?? '',
        message.data,
      );
    });
  }

  void _processNotificationForSingular(
      String title, String body, Map<String, dynamic> data) {
    print('Notification - Title: $title, Body: $body, Data: $data');
    // Add Singular handling here (Step 3)
  }
}

iOS

• Foreground: Similar to Android, handled in Dart.
• Background/Terminated: Requires native iOS integration.

Step 3: Interfacing Push Notifications with the Singular SDK

To ensure Singular tracks push notification engagements for attribution, you need to pass the notification payload to the Singular SDK. This involves Dart code and some native configuration.

Providing Push Payload

1. Android
   • Background: In your Android MainActivity, override onNewIntent to pass the intent to Singular:
     kotlin

     // MainActivity.kt
     package com.example.yourapp
     
     import io.flutter.embedding.android.FlutterActivity
     import android.content.Intent
     import com.singular.sdk.SingularBridge
     
     class MainActivity: FlutterActivity() {
         override fun onNewIntent(intent: Intent) {
             super.onNewIntent(intent)
             SingularBridge.onNewIntent(intent)
         }
     }

   • Terminated: Handled automatically by the Singular bridge layer, no additional code needed.
2. iOS
   • Background: Call handlePushNotification in your Dart code when processing background notifications:
     dart

     void _processNotificationForSingular(
         String title, String body, Map<String, dynamic> data) {
       Singular.handlePushNotification(data);
     }

   • Terminated: Update AppDelegate.swift to handle launch options:
     swift

     import UIKit
     import Singular
     
     @UIApplicationMain
     @objc class AppDelegate: FlutterAppDelegate {
       override func application(
         _ application: UIApplication,
         didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
       ) -> Bool {
         SingularAppDelegate.shared().launchOptions = launchOptions
         return super.application(application, didFinishLaunchingWithOptions: launchOptions)
       }
     }

Setting Push Link Paths in Singular Config

Configure the Singular SDK to recognize specific paths in your notification payloads for Re-engagement attribution:

import 'package:singular_flutter_sdk/singular.dart'; // Adjust import

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();

  // Singular configuration
  SingularConfig config = SingularConfig(
    apiKey: 'your_api_key',
    secret: 'your_secret',
  );

  // Set push notification link paths (same for iOS and Android)
  config.pushNotificationsLinkPaths = [
    ['sng_link'],
    ['rootObj', 'nestedObj', 'anotherNested', 'singularLink'],
  ];

  // Initialize Singular
  Singular.init(config);

  runApp(MyApp());
}

Validation Guide

https://sdk-api-v1.singular.net/api/v1/start?a=<SDK-Key>&ab=arm64-v8a&aifa=180f63a1-0955-47b4-896a-d75ae3d35955&apc=Marchv7&apg=1&aps=Intex&asid_scope=1&asid_timeinterval=0.112&av=20.0&br=samsung&c=wifi&current_device_time=1740905574088&de=m15x&device_type=phone&device_user_agent=Dalvik/2.1.0 (Linux; U; Android 14; SM-E156B Build/UP1A.231005.007)&dnt=0&event_index=3&fi=e5bRZuVddO8:APA91bHXI3OmFZv3-r8f03zyji2kvKWbIngwf8KBDHk4Rj5q5MEeEm6EtzC-if1vpJRmuYLyGdAcSz9-nc49eIjD86xwj-n9J4jKucqMVt9mP8ICifP0arA&i=net.singular.singularsampleapp&install_time=1740905507036&is=false&k=SDID&lag=0.067&lc=en_IN&ma=samsung&mo=SM-E156B&n=Singular-TestApp-Debug&p=Android&pr=m15xnndins&pu=1&rt=json&s=1740905574084&sdk=Singular/v12.6.2&singular_install_id=2dc5dfc2-a2a8-484a-aad1-fed6cb7a3023&singular_link=https://singularassist2.sng.link/C4nw9/r1m0?_dl=singular://test&_smtype=3&src=com.android.shell&u=75f7b911-5a77-597d-8892-56f5e0e210ff&update_time=1740905507036&v=14&h=1e723fd90344d5d037059f110611ed1d84fbba88