Skip to content

Generic Template

A flexible progress-based template suitable for builds, downloads, deployments, and any long-running task.

Live Activity demonstration

Fields

FieldTypeDescription
templatestringRequired. Must be "generic"
progressfloatRequired. Value between 0.0 and 1.0; shown as a percentage in the top-right corner
statestringShort status text (e.g. "Building...", "Complete")
iconstringSF Symbol name (e.g. "arrow.triangle.branch", "washer") or MDI icon with mdi: prefix (e.g. "mdi:washing-machine", "mdi:thermometer")
remaining_timeintegerRemaining time in seconds, shown as a countdown alongside the progress bar
subtitlestringSecondary text below the progress bar
accent_colorstringNamed color or hex (e.g. "cyan", "#00BCD4")
background_colorstringBackground color override
text_colorstringText color override
Coming in app version 1.3.3
Coming in app version 1.7.0
Coming in app version 1.14.0

Renders url_action and secondary_url_action as buttons beneath the progress bar, and treats taps on the rest of the card as tap_action -- see Tap actions.

Example Payload

Start a generic activity
{
  "state": "ongoing",
  "content": {
    "template": "generic",
    "progress": 0.65,
    "state": "Washing",
    "icon": "washer",
    "remaining_time": 1800,
    "subtitle": "Cycle 2 of 3",
    "accent_color": "blue"
  }
}

Live progress

Coming in app version 1.3.3

This section describes a feature in an app update that's pending App Store review. It unlocks here automatically once the update is live.

Coming in app version 1.7.0

This section describes a feature in an app update that's pending App Store review. It unlocks here automatically once the update is live.