ActivitySmith icon

ActivitySmith

Send push notifications and manage Live Activities

Actions6

End Live Activity

AI-generated

Summary

End an existing ActivitySmith Live Activity by sending its activity ID and configured content state to the API. You can choose a segmented progress, progress, or metrics state and optionally set how many minutes it remains visible before dismissal.

Inputs

  • Title (required) — Title for the Live Activity content state.
  • Subtitle — Optional subtitle for the content state.
  • Activity ID (required) — The activity_id returned by Start Live Activity.
  • Activity Type (required) — Choose Segmented Progress, Progress, or Metrics. Countdown is not available.
  • Progress fields — For Segmented Progress, set Current Step and Number of Steps; Step Color is optional. For Progress, provide Percentage or both Value and Upper Limit. Color is available for progress types.
  • Metrics — For Metrics, configure one or two entries, each with a label and numeric value; unit is optional. At least one metric is required.
  • Auto Dismiss Minutes — Optional integer controlling when the ended activity is dismissed. Leave blank for the backend default (3 minutes); set 0 for immediate dismissal.
  • Action — Optionally configure an Open URL or Webhook action with a title and URL. Webhooks also accept GET or POST and an optional JSON object body.

Output shape

A single output item per input item, containing the API response object when the response is an object, otherwise wrapped as {"response": value}.

The request posts the activity ID and content state to ActivitySmith's end Live Activity endpoint. With Continue On Fail enabled, failed items pass through their original input JSON with an error attached.

Links

Discussion