Saltar al contenido

Widgets

Widgets de iOS para Home Screen, Lock Screen y StandBy impulsados por push. Declara un widget una vez, actualiza su contenido con un PATCH y las instancias de WidgetKit del usuario se actualizan automáticamente.

ℹ Información

Widgets require iOS 26 or later. On older versions the iOS app hides the widget management screen and your widgets remain dormant — the server keeps the content current so they render correctly once the user upgrades.

Widgets are persistent — once the user pins one to their Home Screen, Lock Screen, or StandBy, it stays there until they remove it. Use a widget for ambient state that should always be glanceable (a sensor reading, a server health indicator, a daily counter). For something that is currently happening and has a known end — a download, a timer, a print — reach for a Live Activity instead.

Templates

Five flat templates, each tuned for a different shape of data. Tap any card to jump to its content fields in the API reference.

value — Valor

Un único número grande con unidad, etiqueta y flecha de tendencia opcionales. Ideal para lecturas de sensores y contadores.

Required: value (number) + optional unit, label, trend

Value widget — large "20" deploys count on a dark card with badges and an Up trend arrow.

progress — Progreso

Una barra de progreso con etiqueta y color de acento. Ideal para porcentajes de finalización y despliegues.

Required: value 0.0 – 1.0

Progress widget — Pages 100% with a green progress bar and "10 of 10 acked".

status — Estado

Una píldora de estado con icono según la gravedad (info, advertencia, crítico, correcto). Sin números, solo estado.

Required: severity (info, warning, critical, success)

Status widget — Incident card with a green warning octagon and "resolved" pills.

gauge — Indicador

Un indicador de aguja entre un mínimo y un máximo configurables. Ideal para SLO, presupuestos de error y capacidad.

Required: value, min_value, max_value

Gauge widget — Errors dial at 0.4% out of 5%, with MIN/MAX labels and Mute/Logs buttons.

stat_list — Lista de estadísticas

Hasta seis filas de etiqueta/valor. Ideal para paneles compactos — MRR / Suscripciones / Pruebas, Activo / Caído / Mantenimiento.

Required: stat_rows (array, 1 – 6 entries)

Stat list widget — On-call card with Primary, Secondary, and Time left rows.
ℹ Información

stat_list stores up to 6 rows, but how many render depends on the placement size. By default, medium and large Home Screen widgets show all 6; the small widget shows 4, and the Lock Screen rectangular shows 3, packing rows two-up to fit up to 6 when every value is very short (a single status glyph, a small count). You can change Row Density per widget in the PushWard app: Compact packs two columns to surface up to 6 rows on any size (labels may truncate on the small placements), and Comfortable keeps a single column with larger rows (showing fewer on the smaller sizes). To see all 6 rows with full labels, use a medium or large widget, or set Compact.

How it works

  1. Your integration calls POST /widgets to declare a widget by slug, with a template and initial content.
  2. The user opens the widget picker on their device and selects your slug for any system widget family they want — small, medium, large, accessory-rectangular, accessory-circular, or accessory-inline. The same slug can appear in multiple slots.
  3. Your integration calls PATCH /widgets/{slug} whenever the underlying value changes. The server merges (RFC 7396) and pushes a thin update; the iOS widget extension reloads its timeline.
  4. If a push is missed (background fetch coalescing, no network), iOS calls back into the extension every ~30 minutes for a freshness pull — GET /widgets/{slug} always returns the latest content.

Two ways to create widgets

Widgets don't require an integration to exist. There are two paths to the same backend, and both can target the same slug — a widget created in the app can later be driven by an integration, and vice versa.

  • In the iOS app. Open the Widgets tab in PushWard, choose a template, and fill in the slug, name, and initial content. This is the right path for personal widgets — a temperature you key in by hand, a morale dial, a counter you bump from a Shortcut. The new slug appears immediately in the iOS widget picker for Home Screen, Lock Screen, and StandBy.
  • Via the HTTP API. Use this when an external service should keep the widget content current — a homelab probe, a CI job, a smart-home automation. See the API reference.

Authentication

The widgets API is reachable with an integration key (hlk_) that has the widgets flag enabled. This is the right choice for third-party integrations — toggle the flag on the key in the iOS app's integration-keys screen.

Next steps