End Live Activity Stream
end_live_activity_streamEnd the current Live Activity for a managed stream and remove the stream key. Use it when the tracked work is finished; to stop updates temporarily and keep the key, use pause_live_activity_stream instead. A later set_live_activity_stream call with the same key starts a new Live Activity. Ending remotely also uses the device's ActivityKit push budget, so end once for a genuine lifecycle completion and do not repeatedly end and recreate a stream to refresh it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Optional final Tags. Omit to preserve; send [] to clear. | |
| alert | No | Optional APNs alert payload for the ending update. | |
| action | No | Optional action button/tap target. Use { title, type: "open_url", url } with an HTTP/HTTPS URL or shortcuts://run-shortcut?name=... to open a URL or run an iPhone Shortcut. Use { title, type: "webhook", url, method, body } to call an HTTPS webhook. Webhook method can be GET or POST. | |
| metadata | No | Optional final app-only details. Omit to preserve; send {} to clear. | |
| stream_key | Yes | Stable Live Activity stream key. Use the same key to update the same stream. Do not create new keys for routine updates: every new stream requires another remote start and uses the device's limited iOS push-to-start budget. Use only letters, numbers, underscores, and hyphens. | |
| content_state | No | Optional final Live Activity content state. If omitted, ActivitySmith uses the latest stored state when possible. | |
| secondary_action | No | Optional secondary action button for alert, progress, and segmented_progress Live Activities. Uses the same object shape as action. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||