Entrig

Push Notifications for Supabase

Send push notifications to your React Native app, triggered by database events.

---

Prerequisites

1. Create Entrig Account - Sign up at entrig.com

2. Connect Supabase - Authorize Entrig to access your Supabase project

   How it works (click to expand)

   During onboarding, you'll:

   1. Click the "Connect Supabase" button
   2. Sign in to your Supabase account (if not already signed in)
   3. Authorize Entrig to access your project
   4. Select which project to use (if you have multiple)

   That's it! Entrig will automatically set up everything needed to send notifications. No manual SQL or configuration required.

3. Upload FCM Service Account (Android) - Upload Service Account JSON and provide your Application ID

   How to get FCM Service Account JSON (click to expand)

   1. Create a Firebase project at console.firebase.google.com
   2. Add your Android app to the project
   3. Go to Project Settings → Service Accounts
   4. Click "Firebase Admin SDK"
   5. Click "Generate new private key"
   6. Download the JSON file
   7. Upload this file to the Entrig dashboard
   What is Application ID? (click to expand)

   The Application ID is your Android app's package name (e.g., com.example.myapp). You can find it in:

   • Your android/app/build.gradle file under applicationId
   • Or in your AndroidManifest.xml under the package attribute

4. Upload APNs Key (iOS) - Upload .p8 key file with Team ID, Bundle ID, and Key ID to Entrig

   How to get APNs Authentication Key (click to expand)

   1. Enroll in Apple Developer Program
   2. Go to Certificates, Identifiers & Profiles
   3. Navigate to Keys → Click "+" to create a new key
   4. Enter a key name and enable "Apple Push Notifications service (APNs)"
   5. Click "Continue" then "Register"
   6. Download the .p8 key file (you can only download this once!)
   7. Note your Key ID (shown on the confirmation page - 10 alphanumeric characters)
   8. Note your Team ID (found in Membership section of your Apple Developer account - 10 alphanumeric characters)
   9. Note your Bundle ID (found in your Xcode project settings or Info.plist - reverse domain format like com.example.app)
   10. Upload the .p8 file along with Team ID, Bundle ID, and Key ID to the Entrig dashboard
   Production vs Sandbox environments (click to expand)

   Entrig supports configuring both APNs environments:

   • Production: For App Store releases and TestFlight builds
   • Sandbox: For development builds via Xcode

   You can configure one or both environments during onboarding. Developers typically need Sandbox for testing and Production for live releases. You can use the same APNs key for both environments, but you'll need to provide the configuration separately for each.

---

Installation

npm install @entrig/react-native

or

yarn add @entrig/react-native

---

Platform Setup

Android

No setup required for Android. We'll take care of it.

iOS

React Native — Automatic Setup (Recommended)

Run this command in your project root:

npx @entrig/react-native setup ios

This automatically configures:

• AppDelegate.swift with Entrig notification handlers
• Entitlements with push notification capabilities (creates the file if it doesn't exist)
• Info.plist with background modes
• project.pbxproj with CODE_SIGN_ENTITLEMENTS reference

Note: The command creates .backup files for safety. You can delete them after verifying everything works.

Manual AppDelegate setup (click to expand)

1. Enable Push Notifications in Xcode

• Open ios/YourApp.xcworkspace
• Select your target → Signing & Capabilities
• Click + Capability → Push Notifications
• Click + Capability → Background Modes → Enable Remote notifications

2. Update AppDelegate.swift

Add import UserNotifications and import EntrigSDK, add UNUserNotificationCenterDelegate conformance, then add the notification methods.

RN 0.74+ (new style — UIResponder, UIApplicationDelegate)

import UIKit
import React
import React_RCTAppDelegate
import ReactAppDependencyProvider
import UserNotifications
import EntrigSDK

@main
class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterDelegate {
  var window: UIWindow?
  var reactNativeDelegate: ReactNativeDelegate?
  var reactNativeFactory: RCTReactNativeFactory?

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
  ) -> Bool {
    UNUserNotificationCenter.current().delegate = self
    Entrig.checkLaunchNotification(launchOptions)

    let delegate = ReactNativeDelegate()
    let factory = RCTReactNativeFactory(delegate: delegate)
    delegate.dependencyProvider = RCTAppDependencyProvider()
    reactNativeDelegate = delegate
    reactNativeFactory = factory
    window = UIWindow(frame: UIScreen.main.bounds)
    factory.startReactNative(withModuleName: "YourApp", in: window, launchOptions: launchOptions)
    return true
  }

  func application(_ application: UIApplication,
                   didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    Entrig.didRegisterForRemoteNotifications(deviceToken: deviceToken)
  }

  func application(_ application: UIApplication,
                   didFailToRegisterForRemoteNotificationsWithError error: Error) {
    Entrig.didFailToRegisterForRemoteNotifications(error: error)
  }

  func userNotificationCenter(_ center: UNUserNotificationCenter,
                               willPresent notification: UNNotification,
                               withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
    Entrig.willPresentNotification(notification)
    completionHandler(Entrig.getPresentationOptions())
  }

  func userNotificationCenter(_ center: UNUserNotificationCenter,
                               didReceive response: UNNotificationResponse,
                               withCompletionHandler completionHandler: @escaping () -> Void) {
    Entrig.didReceiveNotification(response)
    completionHandler()
  }
}

Replace "YourApp" with your actual module name.

RN 0.71–0.73 (old style — RCTAppDelegate)

import UIKit
import UserNotifications
import EntrigSDK

@main
class AppDelegate: RCTAppDelegate, UNUserNotificationCenterDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
  ) -> Bool {
    UNUserNotificationCenter.current().delegate = self
    Entrig.checkLaunchNotification(launchOptions)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }

  override func application(_ application: UIApplication,
                             didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    Entrig.didRegisterForRemoteNotifications(deviceToken: deviceToken)
    super.application(application, didRegisterForRemoteNotificationsWithDeviceToken: deviceToken)
  }

  override func application(_ application: UIApplication,
                             didFailToRegisterForRemoteNotificationsWithError error: Error) {
    Entrig.didFailToRegisterForRemoteNotifications(error: error)
    super.application(application, didFailToRegisterForRemoteNotificationsWithError: error)
  }

  func userNotificationCenter(_ center: UNUserNotificationCenter,
                               willPresent notification: UNNotification,
                               withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
    Entrig.willPresentNotification(notification)
    completionHandler(Entrig.getPresentationOptions())
  }

  func userNotificationCenter(_ center: UNUserNotificationCenter,
                               didReceive response: UNNotificationResponse,
                               withCompletionHandler completionHandler: @escaping () -> Void) {
    Entrig.didReceiveNotification(response)
    completionHandler()
  }
}

Expo (Managed Workflow)

Step 1: Configure your bundle identifier

Update your app.json with a proper bundle identifier (not the default Expo one):

{
  "expo": {
    "ios": {
      "bundleIdentifier": "com.yourcompany.yourapp"
    }
  }
}

Important: Don't use Expo's auto-generated bundle IDs (like com.anonymous.*). Use your own reverse-domain identifier.

Step 2: Add the config plugin

Add the plugin to your app.json:

{
  "expo": {
    "plugins": ["@entrig/react-native"]
  }
}

Step 3: Run prebuild

npx expo prebuild
# or run directly (prebuild happens automatically)
npx expo run:ios
npx expo run:android

Note: npx expo run:ios automatically runs npx expo prebuild if the ios/ folder doesn't exist. The plugin runs during prebuild and configures everything automatically.

The plugin automatically configures:

• ✅ AppDelegate with Entrig notification handlers (supports Expo SDK 54+)
• ✅ Info.plist with background modes (UIBackgroundModes: ["remote-notification"])
• ✅ Entitlements with push capabilities (aps-environment: development)

Step 4: Enable Push Notifications in Apple Developer Portal

1. Go to Apple Developer Portal
2. Select your Bundle ID (the one from your app.json)
3. Enable "Push Notifications" capability
4. Save

Step 5: Select your development team in Xcode

1. Open ios/YourApp.xcworkspace in Xcode
2. Select your project in the navigator
3. Go to "Signing & Capabilities" tab
4. Select your Team from the dropdown
5. Xcode will automatically generate the provisioning profile with push notifications

Common error: If you see "Your provisioning profile doesn't support Push Notifications", make sure you completed Step 4 and Step 5.

Step 6: Verify configuration (Optional)

After prebuild, verify the plugin worked correctly:

1. Check AppDelegate (ios/YourApp/AppDelegate.swift):

   • Should have import EntrigSDK and import UserNotifications
   • Should have UNUserNotificationCenterDelegate conformance
   • Should have Entrig notification methods

2. Check Info.plist (ios/YourApp/Info.plist):

   <key>UIBackgroundModes</key>
   <array>
     <string>remote-notification</string>
   </array>

3. Check Entitlements (ios/YourApp/YourApp.entitlements):

   <key>aps-environment</key>
   <string>development</string>

If the plugin didn't work (manual setup)

If any of the above are missing after prebuild, add them manually:

1. Update AppDelegate.swift

Add imports at the top:

import UserNotifications
import EntrigSDK

Add UNUserNotificationCenterDelegate to class declaration:

public class AppDelegate: ExpoAppDelegate, UNUserNotificationCenterDelegate {

Add setup in didFinishLaunchingWithOptions (right after the function opens):

public override func application(
  _ application: UIApplication,
  didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
) -> Bool {
  // Entrig: Setup push notification handling
  UNUserNotificationCenter.current().delegate = self
  Entrig.checkLaunchNotification(launchOptions)

  // ... rest of existing code
}

Add notification methods before the closing brace } of AppDelegate:

// MARK: - Entrig Push Notification Handling

public override func application(
  _ application: UIApplication,
  didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data
) {
  Entrig.didRegisterForRemoteNotifications(deviceToken: deviceToken)
  super.application(application, didRegisterForRemoteNotificationsWithDeviceToken: deviceToken)
}

public override func application(
  _ application: UIApplication,
  didFailToRegisterForRemoteNotificationsWithError error: Error
) {
  Entrig.didFailToRegisterForRemoteNotifications(error: error)
  super.application(application, didFailToRegisterForRemoteNotificationsWithError: error)
}

public func userNotificationCenter(
  _ center: UNUserNotificationCenter,
  willPresent notification: UNNotification,
  withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void
) {
  Entrig.willPresentNotification(notification)
  completionHandler(Entrig.getPresentationOptions())
}

public func userNotificationCenter(
  _ center: UNUserNotificationCenter,
  didReceive response: UNNotificationResponse,
  withCompletionHandler completionHandler: @escaping () -> Void
) {
  Entrig.didReceiveNotification(response)
  completionHandler()
}

2. Update Info.plist (ios/YourApp/Info.plist)

Add this before the closing </dict> tag:

<key>UIBackgroundModes</key>
<array>
  <string>remote-notification</string>
</array>

3. Update Entitlements (ios/YourApp/YourApp.entitlements)

Replace the contents with:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>aps-environment</key>
    <string>development</string>
  </dict>
</plist>

Note: Change development to production for App Store releases.

---

Troubleshooting

Native Entrig module not found (iOS)

This means the EntrigReactNative pod was not installed. Run:

cd ios && pod install

Then rebuild the app. If the error persists, verify EntrigReactNative appears in ios/Podfile.lock:

grep "EntrigReactNative" ios/Podfile.lock

If it's missing, make sure you are on @entrig/react-native version that includes the root-level EntrigReactNative.podspec and re-run pod install.

Push token not generated (iOS)

The device token won't be generated if the AppDelegate is not configured. Run the setup command:

npx @entrig/react-native setup ios

Then rebuild. Also ensure:

• Push Notifications capability is added in Xcode (Target → Signing & Capabilities)
• You are testing on a real device (simulators cannot receive push notifications)
• The APNs key is uploaded to your Entrig dashboard

pod install CocoaPods dependency errors

Try cleaning and reinstalling:

cd ios
rm Podfile.lock
rm -rf Pods
pod deintegrate
pod repo update
pod install

---

Usage

Initialize

import Entrig from '@entrig/react-native';

// Initialize Entrig (call once at app startup)
await Entrig.init({ apiKey: 'YOUR_ENTRIG_API_KEY' });

How to get your Entrig API key (click to expand)

1. Sign in to your Entrig account at entrig.com
2. Go to your dashboard
3. Navigate to your project settings
4. Copy your API Key from the project settings page
5. Use this API key in the Entrig.init() call above

Register/Unregister Devices

Automatic registration with Supabase Auth (Recommended - click to expand)

Listen to Supabase auth state changes and automatically register/unregister devices:

import { useEffect } from 'react';
import Entrig from '@entrig/react-native';
import { supabase } from './supabase'; // your Supabase client

function App() {
  useEffect(() => {
    const { data: { subscription } } = supabase.auth.onAuthStateChange(
      async (event, session) => {
        if (session?.user) {
          // User signed in - register device
          await Entrig.register(session.user.id);
        } else {
          // User signed out - unregister device
          await Entrig.unregister();
        }
      }
    );

    return () => subscription.unsubscribe();
  }, []);

  return <YourApp />;
}

Important: Devices are registered with the Supabase Auth user ID (auth.users.id). When creating notifications, make sure the user identifier field you select contains this same Supabase Auth user ID to ensure notifications are delivered to the correct users.

Manual registration (click to expand)

Register device:

const { data: { user } } = await supabase.auth.getUser();
if (user) {
  await Entrig.register(user.id);
}

Unregister device:

await Entrig.unregister();

Note: register() automatically handles permission requests. The userId you pass here must match the user identifier field you select when creating notifications.

Custom permission handling (click to expand)

If you want to handle notification permissions yourself, disable automatic permission handling:

await Entrig.init({
  apiKey: 'YOUR_ENTRIG_API_KEY',
  handlePermission: false,
});

Then request permissions manually before registering:

const granted = await Entrig.requestPermission();

Listen to Notifications

Using the useEntrigEvent hook (Recommended):

import { useEntrigEvent } from '@entrig/react-native';

function MyComponent() {
  // Foreground notifications (when app is open)
  useEntrigEvent('foreground', (event) => {
    console.log('Notification received:', event.title, event.body);
  });

  // Notification tap (when user taps a notification)
  useEntrigEvent('opened', (event) => {
    // Navigate to specific screen based on event.data
    console.log('Notification opened:', event.data);
  });

  return <YourComponent />;
}

Using event listeners directly:

import Entrig from '@entrig/react-native';

// Foreground notifications
const subscription = Entrig.onForegroundNotification((event) => {
  console.log('Foreground:', event.title, event.body);
});

// Notification tap
const subscription2 = Entrig.onNotificationOpened((event) => {
  console.log('Opened:', event.data);
});

// Clean up when done
subscription.remove();
subscription2.remove();

Get the notification that launched the app (cold start):

const notification = await Entrig.getInitialNotification();
if (notification) {
  // App was launched from a notification tap
  console.log('Launched from notification:', notification.data);
}

NotificationEvent contains:

• title - Notification title
• body - Notification body text
• data - Custom payload data from your database
• isForeground - Whether the notification was received in the foreground

---

Creating Notifications

Learn how to create notification triggers in the dashboard (click to expand)

Create notification triggers in the Entrig dashboard. The notification creation form has two sections: configuring the trigger and composing the notification message.

Section 1: Configure Trigger

Set up when and to whom notifications should be sent.

1. Select Table

Choose the database table where events will trigger notifications (e.g., messages, orders). This is the "trigger table" that activates the notification.

2. Select Event

Choose which database operation triggers the notification:

• INSERT - When new rows are created
• UPDATE - When existing rows are modified
• DELETE - When rows are deleted

3. Select User Identifier

Specify how to identify notification recipients. Toggle "Use join table" to switch between modes.

Important: The user identifier field you select here must contain the same user ID that was used when registering the device. This should be the Supabase Auth user ID (auth.users.id).

Single User Mode (Default):

• Select a field that contains the user ID directly
• Supports foreign key navigation (e.g., navigate through orders.customer_id to reach customers.user_id)
• Example: For a messages table with user_id field, select user_id

Multi-User Mode (Join Table):

• Use when one database event should notify multiple users

• Requires configuring the relationship between tables:

  Event Table Section:

  • Lookup Field: Select a foreign key field that links to your join table
    • Example: For notifying all room members when a message is sent, select room_id from the messages table

  Join Table Section:

  • Join Table: Select the table containing recipient records
    • Example: room_members table that links rooms to users
  • Matching Field: Field in the join table that matches your lookup field
    • Usually auto-populated to match the lookup field name
  • User ID Field: Field containing the actual user identifiers
    • Supports foreign key navigation
    • Should contain the same user ID used during device registration

4. Event Conditions (Optional)

Filter when notifications are sent based on the trigger event data:

• Add conditions to control notification sending (e.g., only when status = 'completed')
• Supports multiple conditions with AND/OR logic

5. Recipient Filters (Optional, Multi-User only)

Filter which users receive the notification based on join table data:

• Example: Only notify users where role = 'admin' in the join table

Section 2: Compose Notification

Design the notification content that users will see.

1. Payload Data (Optional)

Select database fields to use as dynamic placeholders:

• Click "Add Fields" to open the field selector
• Selected fields appear as clickable pills (e.g., {{messages.content}})
• Click any pill to insert it at your cursor position in title or body

2. Title & Body

Write your notification text using placeholders:

• Use double-brace format: {{table.column}}
• Example Title: New message from {{users.name}}
• Example Body: {{messages.content}}
• Placeholders are replaced with actual data when notifications are sent

Example Use Cases

Single User Notification:

• Table: orders, Event: INSERT
• User ID: customer_id
• Title: Order Confirmed!
• Body: Your order #{{orders.id}} has been received

Multi-User Notification (Group Chat):

• Table: messages, Event: INSERT
• Lookup Field: room_id
• Join Table: room_members
• Matching Field in Join Table: room_id
• User ID: user_id
• Title: New message in {{rooms.name}}
• Body: {{users.name}}: {{messages.content}}

---

Support

• Email: team@entrig.com

---