Generic Template

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

Fields

Field	Type	Description
`template`	string	Required. Must be `"generic"`
`progress`	float	Required. Value between `0.0` and `1.0`
`state`	string	Short status text (e.g. "Building...", "Complete")
`icon`	string	SF Symbol name (e.g. `"arrow.triangle.branch"`, `"washer"`) or MDI icon with `mdi:` prefix (e.g. `"mdi:washing-machine"`, `"mdi:thermometer"`)
`remaining_time`	integer	Remaining time in seconds
`subtitle`	string	Secondary text below the progress bar
`accent_color`	string	Named color or hex (e.g. `"cyan"`, `"#00BCD4"`)
`background_color`	string	Background color override
`text_color`	string	Text color override

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"
  }
}

Typical Flow

Start (ENDED -> ONGOING): Set progress: 0.0 with an initial status
Update (ONGOING -> ONGOING): Increment progress, change status text
End (ONGOING -> ENDED): Set progress: 1.0 with a completion status

💡 Tip

The progress percentage is displayed in the top-right corner of the Live Activity. Use remaining_time to show a countdown alongside the progress bar.

Integrations Using This Template

SABnzbd — tracks download progress with speed and ETA
Bambu Lab — tracks 3D print progress with layer counts and temperature
Home Assistant — default template for entity state tracking