Actions6
Start Live Activity
AI-generatedSummary
Start a Live Activity with a title and a selected layout: segmented progress, continuous progress, or metrics. The node sends the request to ActivitySmith for each input item and returns the API response, including the activity ID when provided by the API.
Inputs
- Title (required) — Title displayed in the Live Activity.
- Subtitle — Optional subtitle.
- Channels — Comma- or newline-separated channel slugs to target. If empty, the API key's recipient scope is used.
- Activity Type (required) — Choose Segmented Progress, Progress, or Metrics. Countdown is not available.
- Segmented Progress fields — For segmented progress, set Current Step and Number of Steps. Step Color is optional; Color sets the accent color.
- Progress fields — For continuous progress, provide Percentage, or both Value and Upper Limit. Percentage takes precedence when supplied. Color sets the accent color.
- Metrics — For metrics, provide one or two entries, each with a required non-empty Label and numeric Value; Unit is optional.
- Action — Optionally configure an Open URL or Webhook action with a title and URL. For a webhook, choose GET or POST and optionally provide a JSON object body; the default method is POST.
Output shape
One output item per input item, containing the API response as JSON.
Object responses are returned directly; non-object responses are wrapped in a
responsefield. The request is sent to the ActivitySmith API using the required ActivitySmith API credential. Invalid progress or metrics settings, or an incomplete action, raise an error.