Live Activity Stream
Use a stable stream_key for each ongoing thing you want to show as a Live Activity. Send the latest content_state whenever it changes, and ActivitySmith will keep the Live Activity in sync. For timer streams, send duration_seconds to start or reset the timer; omit duration_seconds on later updates to preserve the existing timer window. Use secondary_action for a second button on alert, progress, and segmented_progress Live Activities. Optional tags to organize and filter notification history. On later stream updates, omit tags to keep the current tags, send tags again to replace them, or send an empty array to clear them.
- Send the latest state for a stable
stream_key. - If the Live Activity does not exist yet, ActivitySmith starts it.
- If it already exists, ActivitySmith updates it.
- You do not need to keep local state between updates.
- For
timer, sendduration_secondsfor countdowns. To start at 00:00 and count up, setcounts_downtofalseand leave outduration_seconds. - Later
timerupdates can change visible fields without sendingduration_seconds.
DELETE /live-activity/stream/{stream_key}.Authorizations
Required. Include Authorization: Bearer ask_123456789 in every request. Replace ask_123456789 with your API key.
Path Parameters
Stable identifier for one ongoing thing. Allowed characters: letters, numbers, underscores, and hyphens.
255^[A-Za-z0-9_-]+$Body
Send the latest state for a managed Live Activity stream. channels is the streamlined form for stream targeting. target.channels is also accepted for compatibility. If both are provided, they must match.
Current state for a managed Live Activity stream. Include type on the first PUT, and whenever the stream may need to start a fresh activity. Supports segmented_progress, progress, metrics, stats, alert, and timer types. For timer, send duration_seconds to start or reset a bounded timer; omit duration_seconds on later updates to preserve the existing timer window.
Optional action button shown in the Live Activity UI. Use action for the primary button, or secondary_action for a secondary button on alert, progress, and segmented_progress Live Activities.
Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action.
Channel slugs. When omitted, API key scope determines recipients.
1Optional tags to organize and filter notification history. Omit this field on later updates to keep the current tags, send tags again to replace them, or send an empty array to clear them.
1 - 64^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$Response
Stream reconciled
Returned after a managed stream request is reconciled.
started, updated, rotated, noop, paused Optional tags to organize and filter notification history.
1 - 64^[A-Za-z0-9][A-Za-z0-9._:-]{0,63}$