Yallapush Docuuuumentation

Yallapush is designed for product teams, marketers, and developers to send push notifications from web and mobile platforms. It integrates seamlessly with Firebase Cloud Messaging (FCM) and provides a centralized interface for managing devices, grouping users, and sending targeted notifications.

Before getting started with Yallapush, ensure the following Firebase setup is complete:

1. Clients (web or mobile) integrate Firebase SDK.
2. On app load or login, the device generates a Firebase Token (FCM Token).
3. On the Yallapush dashboard:
   • Admin creates a project and uploads the google-services.json file.
   • Yallapush reads the Firebase config and automatically registers the device.
4. Yallapush stores:
   • FCM token
   • Device info (platform, model, version)
   • User email and name
   • Project association
5. Admins can now send individual or group notifications, or launch scheduled campaigns.

Each project must link its Firebase configuration to Yallapush:

// Example Firebase configuration
{
  "apiKey": "YOUR_API_KEY",
  "authDomain": "your-app.firebaseapp.com",
  "projectId": "your-app",
  "storageBucket": "your-app.appspot.com",
  "messagingSenderId": "1234567890",
  "appId": "1:1234567890:web:abcdef1234567890"
}

Installation

# Install React Native Firebase packages
npm install @react-native-firebase/app @react-native-firebase/messaging

# For iOS, install pods
cd ios && pod install

Android Configuration

1. Place your google-services.json in android/app/
2. Update android/build.gradle:
   gradle

   buildscript {
     dependencies {
       classpath 'com.google.gms:google-services:4.3.15'
     }
   }

3. Update android/app/build.gradle:
   gradle

   apply plugin: 'com.google.gms.google-services'

iOS Configuration

1. Place GoogleService-Info.plist in your Xcode project
2. Enable Push Notifications in Xcode under Signing & Capabilities
3. Add Background Modes capability with Remote Notifications

Implementation

import React, { useEffect } from 'react';
import { Platform } from 'react-native';
import messaging from '@react-native-firebase/messaging';

async function registerDeviceWithYallapush(token) {
  await fetch('https://api.yallapush.com/register-device', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      fcmToken: token,
      deviceInfo: {
        platform: Platform.OS,
        version: Platform.Version
      }
    })
  });
}

function App() {
  useEffect(() => {
    const setupPushNotifications = async () => {
      await messaging().requestPermission();
      const token = await messaging().getToken();
      await registerDeviceWithYallapush(token);
      
      messaging().onTokenRefresh(token => {
        registerDeviceWithYallapush(token);
      });
    };

    setupPushNotifications();

    messaging().onMessage(async remoteMessage => {
      console.log('Notification received:', remoteMessage);
    });
  }, []);

  return (
    // Your app components
  );
}

Testing

• Run on a physical device (not simulator)
• Check console logs for the FCM token
• Verify the token appears in your Yallapush dashboard
• Send a test notification from Yallapush

Yallapush supports automatic device registration during Firebase setup.

Automatic Registration

When you upload the google-services.json file via the Dashboard:

• Yallapush reads the configuration
• Automatically registers the device and platform info (e.g., Android, iOS)
• Associates it with your project using your API Key

Manual Registration API

For cases where automatic registration isn't possible, use our registration API:

POST /api/register-device
Authorization: Bearer <Company_API_Key>
Content-Type: application/json

{
  "email": "john.doe@example.com",
  "name": "John Doe",
  "fcmToken": "abc123xyz",
  "deviceInfo": {
    "platform": "android",
    "version": "14",
    "model": "Samsung S21"
  }
}

Yallapush provides a comprehensive API for managing push notifications programmatically.