1. Enable Push Notifications in Xcode

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

2. Update AppDelegate.swift

import Flutter
import UIKit
import entrig
import UserNotifications

@main
@objc class AppDelegate: FlutterAppDelegate {
    override func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
        GeneratedPluginRegistrant.register(with: self)

        // Setup Entrig notification handling
        UNUserNotificationCenter.current().delegate = self
        EntrigPlugin.checkLaunchNotification(launchOptions)

        return super.application(application, didFinishLaunchingWithOptions: launchOptions)
    }

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

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

    // MARK: - UNUserNotificationCenterDelegate
    override func userNotificationCenter(_ center: UNUserNotificationCenter,
                                        willPresent notification: UNNotification,
                                        withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void) {
        EntrigPlugin.willPresentNotification(notification)
        completionHandler([])
    }

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

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

If you prefer to handle registration manually, initialize without autoRegisterWithSupabaseAuth:

await Entrig.init(apiKey: 'YOUR_ENTRIG_API_KEY');

Then register/unregister manually:

Register device:

final userId = Supabase.instance.client.auth.currentUser?.id;
if (userId != null) {
  await Entrig.register(userId: userId);
}

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:

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 using Entrig.requestPermission() before registering.

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. If using autoRegisterWithSupabaseAuth, 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
• The selected field should contain the same user ID used during device registration

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
    • Example: room_id in room_members
  • User ID Field: Field containing the actual user identifiers
    • Supports foreign key navigation
    • Example: user_id in room_members
    • Should contain the same user ID used during device registration (e.g., Supabase Auth user ID)

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
• Conditions check the row data from the trigger table

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
• Different from Event Conditions - these filter recipients, not events

Section 2: Compose Notification #

Design the notification content that users will see.

1. Notification Type (Optional)

Add a custom type identifier for your Flutter app to recognize this notification:

• Example values: new_message, order_update, friend_request
• Access via event.type in your notification listeners
• Use to route users to different screens or handle notifications differently

2. 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
• Supports nested field selection through foreign keys

3. 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
• Title appears as the notification headline
• Body appears as the notification message

What Happens Behind the Scenes #

When you create a notification, Entrig automatically:

1. Enables pg_net extension in your Supabase project
2. Creates a PostgreSQL function to send HTTP requests to Entrig
3. Sets up a database trigger on your selected table
4. Configures webhook endpoint for your notification

No manual SQL or backend code required!

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 {{messages.room_name}}
• Body: {{messages.sender_name}}: {{messages.content}}