scheduled-notifications

Test Notification

Generate a test notification for a user. Shows exactly what would be generated by the production batch system.

Args:

  • x-user-id (header): The user ID to generate notification for
  • sendToDevice (body): If true, actually sends the notification to the user's device. Default: false
  • deliveryMethod (body): "push" for regular push notification, "live_activity" for iOS Live Activity. Default: "push"
  • notificationType (body): "personalized", "prayer", or "journaling". Default: "personalized"
  • timeOfDay (body): "morning", "noon", "evening", "night", or "generic". Default: "generic"
  • interruptionLevel (body): Optional Expo iOS interruption level for push tests. Use "time-sensitive" to test Time Sensitive notifications.

Returns:

  • notification_type: Type of notification generated
  • notification: The generated title and body
  • memories_count: How many memories were used (only for personalized)
  • sent_to_device: Whether notification was sent to device
  • delivery_method: How the notification was delivered

Requires x-api-key header for authentication.

post/api/scheduled-notifications/admin/test

Request

Headers

x-user-idstring required
x-api-keystring required

Request body

sendToDeviceboolean
deliveryMethodstring
notificationTypestring
timeOfDaystring
imageUrlstring nullable
senderNamestring nullable
interruptionLevelstring nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 23 revisions of this API.