Notifications API
The Notifications service manages push notifications (APNs/FCM), email delivery (via Resend), and user notification preferences.
OpenAPI Spec Not Yet Created
This API reference will be auto-generated from services/notifications/api/openapi.yaml using docusaurus-plugin-openapi-docs once the OpenAPI spec is created. The content below is a high-level summary.
What This API Covers
Push Token Registration
- PUT /api/v1/notifications/push-token — Register or update a device push token (APNs for iOS, FCM for Android)
Notification Preferences
- PUT /api/v1/notifications/preferences — Update notification preferences (which notification types to receive, preferred channels)
Delivery
The Notifications service consumes events from Redis Streams (gl:events:notifications) and delivers notifications through the appropriate channel:
| Channel | Provider | Use Case |
|---|---|---|
| Push (iOS) | APNs | Study reminders, new content alerts |
| Push (Android) | FCM | Study reminders, new content alerts |
| Resend | Account notifications, subscription changes |
Authentication
All Notifications API endpoints require a valid Bearer token. See the API Overview for details.