Sign in

v4

latestOpenAPI 3.1.02026-08-08221179273.1 KB
scheduled-notifications

Test Live Activity

Trigger a Live Activity on a user's device for testing.

Pick a variant from the Swagger "Examples" dropdown (prayer / church / devotional / custom reminder, streak, or standard) and send. Reminders carry the per-subtype artwork (via the deep link's reminderType), the weekly streak bubbles, and the interactive snooze.

  • x-user-id (header): user to send the Live Activity to (must have a stored live_activity_tokens pushToStart token)
  • Requires x-api-key header for authentication.
post/api/scheduled-notifications/admin/test-live-activity

Headers

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

Request body

notificationType'standard' | 'reminder' | 'streak' | 'call'

Enum for Live Activity notification types

reminderTypestring nullable

prayer | church | devotional | custom (reminder only)

titlestring required

Main title text (ignored for streak type)

bodystring

Subtitle / body text

deepLinkUrlstring nullable

Override the deep link. Defaults per type/subtype when omitted.

streakCountinteger nullable

Streak count (streak type)

streakDaysboolean[] nullable

7 booleans Sun→Sat for the reminder weekly bubbles

includeSnoozeboolean

Wire snooze fields so the 'remind me later' UI works (reminder only)

snoozeTaskIdstring nullable

Reminder task id used by the snooze flow. Use a real reminder id to actually re-send on snooze; defaults to a placeholder otherwise.

Response

Successful Response

{"stackTrail":"paths:/api/scheduled-notifications/admin/test-live-activity:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}