Skip to main content

Push Notifications Overview

Push notifications are an essential feature of the Tribe platform, allowing administrators to send timely updates and announcements to users through their mobile devices. This functionality is particularly useful for increasing user engagement, delivering important information, and driving users back to the platform.

Architecture​

The Tribe API's push notification system is built on Firebase Cloud Messaging (FCM) and consists of:

  1. REST API Endpoints - For managing notifications through the Tribe API
  2. Firebase Integration - For delivering notifications to mobile devices
  3. Scheduled Notifications - Support for sending notifications at a future date

Available Endpoints​

EndpointMethodDescription
/api/push-notificationsGETRetrieve push notifications
/api/push-notificationsPOSTSend a new push notification
/api/push-notification/:idDELETEDelete a scheduled push notification

Common Use Cases​

  • Announcements - Inform users about new content or features
  • Reminders - Notify users about upcoming events or deadlines
  • Engagement - Re-engage inactive users with personalized messages
  • Updates - Alert users about changes to content they follow

Push notifications support three types of linking behavior:

Simple notifications with no action when tapped. Users see the notification but are not directed to any specific content or page.

2. Content Link​

Links to specific content within the app (videos, posts, articles, etc.). When a user taps the notification:

  • The mobile app navigates to the PostView screen
  • The specific content is loaded and displayed
  • Requires selecting a group first, then choosing content from that group
  • The destinationPage is automatically set to "PostView"
  • The parameterData includes the contentId

Opens external URLs in the device's default browser (Zoom meetings, Google Docs, external websites, etc.). When a user taps the notification:

  • The mobile app opens the URL in the device's browser
  • Useful for directing users to external resources, meeting links, or third-party content
  • The destinationPage is set to "ExternalLink"
  • The parameterData includes the externalUrl

Important: Content links and external links are mutually exclusive - you can only use one type per notification.

Authentication​

All push notification endpoints require authentication with admin privileges. This ensures that only authorized platform administrators can send notifications to users.

Best Practices​

  1. Keep messages concise - Push notification messages should be clear and to the point
  2. Use appropriate timing - Consider user time zones when scheduling notifications
  3. Personalize when possible - Target specific user groups for more relevant messaging
  4. Don't overuse - Excessive notifications can lead to users disabling them
  5. Include action items - Give users a clear next step when they receive a notification

Implementation Notes​

  • Push notifications are delivered through Firebase Cloud Messaging to mobile devices
  • Notifications can be sent immediately or scheduled for a future date
  • Scheduled notifications can be deleted before they are sent
  • The system supports targeting specific user groups
  • Custom destination pages and parameter data can be included for deep linking