Skip to content

Badges

In the admin: Dashboard, then any app. See the Settings reference.

A badge is the small pill on the corner of an app tile. It carries context without adding a widget.

! Health check
4K Fixed label
7 Live activity

Each kind is turned on per app, in that app’s edit form under Badge.

The Badge section of an app's edit form: Health Check, Fixed Label and Live ActivityThe Badge section of an app's edit form: Health Check, Fixed Label and Live Activity
The three kinds, each with its own toggle. Live Activity opens the API fields when it is on.

Reports whether a service is up.

TypeWhat it reads
ContainerThe container’s state from the Docker daemon.
PingThe HTTP status from a URL you give it.

Healthy shows green. A problem shows ! and hovering gives the reason: container not found, container not running, daemon reported it unhealthy, ping failed, or ping returned an error status.

Container checks need Docker Container Health Checks turned on in General, plus socket access. See Advanced configuration. Ping checks need neither.

Turn on Hide Healthy Badge in General to show a badge only when something is wrong.

Text you type once, capped at 10 characters. Pick a colour from the swatches or give a hex value.

A number read from a service’s own API.

Enter the API URL and press Fetch. Stackyard reads the response and lists every number it found, including array lengths and counts of matching items, so you pick one. No custom widget, no code.

FieldWhat it doesExample
API URLThe endpoint to poll.https://requests.example.com/api/v1/request/count
ValueWhich number from the response to show.pending
AuthenticationA header or parameter to send. Tick Secret to keep the value out of the browser.Header X-Api-Key, Secret ticked
UnitA short suffix after the number.requests
Show FromThe count below which the badge stays hidden.1
PollHow often to re-read the endpoint.300 seconds
ColorThe badge fill.#ffcc00

That example badges a request manager with its pending count. Pointing the same fields at Sonarr’s queue instead badges episodes still downloading.

Show From sets a floor, so a queue that is never quite empty stays quiet until it matters. Leave it blank to badge any count above zero. A count above 99 shows as 99+.

An app can have several configured. The first of these that applies is the one drawn.

1 ! Health problemAlways outranks a count, so a fault is never hidden behind a number.
2 7 Live activityOnly at or above Show From.
3 4K Fixed label
4   HealthyHidden when Hide Healthy Badge is on.
5 Nothing

If a poll fails, the last known badge stays on the tile and is marked stale. A failed poll is never read as zero.

7 Current
7 Stale

Every badge carries a text description for screen readers, so meaning is never carried by colour alone. Dark text is used where it beats white for contrast.