Skip to main content
POST
Node
Use this manual lifecycle endpoint only when you need direct control over a specific Live Activity instance. For new integrations, prefer DELETE /live-activity/stream/{stream_key}. This endpoint ends an existing Live Activity by activity_id.
  • metrics: send the final metrics array if you want the ended state to show final values.
  • stats: send the final metrics array if you want the ended state to show final labeled values.
  • segmented_progress: send the final current_step and optionally the latest number_of_steps.
  • progress: send the final percentage, or value with upper_limit.
  • timer: leave duration_seconds out if you want the ended state to preserve the current timer value.
  • action is optional if you want the ended state to keep showing a button before dismissal.
  • auto_dismiss_minutes is optional if you want to control how long the ended Live Activity stays visible.
For segmented_progress, the final payload can include an updated number_of_steps as well as the final current_step. The step count does not need to match the value used when the activity started.

Authorizations

Authorization
string
header
required

Required. Include Authorization: Bearer ask_123456789 in every request. Replace ask_123456789 with your API key.

Body

application/json

End an existing Live Activity by activity_id.

activity_id
string
required
content_state
object
required

End payload requires title. For segmented_progress include current_step and optionally number_of_steps. For progress include percentage or value with upper_limit. For metrics and stats include a non-empty metrics array. For alert include message. For timer, omit duration_seconds to preserve and freeze the latest timer state. Optional icon is supported by all Live Activity types. Optional badge is supported by alert, progress, and segmented_progress. Type is optional when ending an existing activity. You can send an updated number_of_steps here if the workflow changed after start.

action
object

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.

secondary_action
object

Optional secondary action button. Supported for alert, progress, and segmented_progress Live Activities. Uses the same open_url, shortcuts://, and webhook shapes as action.

Response

Live Activity ended

Returned after a Live Activity end event is sent or queued.

success
boolean
required
activity_id
string
required
timestamp
string<date-time>
required
devices_queued
integer
devices_notified
integer