Docs
Widgets / directory

Notification

NOTIFICATION

Service widget that emits push notifications rather than rendering UI on the canvas.

At a glance

Default2 x 2
Minimum2 x 2
Resizenone
Pinoptional
Interactiveno

Behavior

  • Not meant to occupy visible dashboard space in final user layouts.
  • Best paired with Eventor and Timer automation flows.
  • The current app only registers push delivery for dashboards that actually contain a Notification widget.

Firmware contract

Trigger it when the board or rules layer needs to alert the user.

On the app side this widget snaps to the 8-column square grid and uses none resizing. Its raw type is NOTIFICATION and the matching icon token in the app is bell.fill.

Pin support: No interactive pin. It uses push token state associated with the dashboard/user.

Transmission: Server-side push delivery once the widget is initialized with tokens.

Canvas preview

docs.widget.preview
push
Notification

Widget contract

PropertyValue
Raw typeNOTIFICATION
Default size2 x 2
Minimum size2 x 2
Resize modenone
Pin requirementoptional / infrastructure
Pin supportNo interactive pin. It uses push token state associated with the dashboard/user.
Interactiveread-only / service
TransmissionServer-side push delivery once the widget is initialized with tokens.

Allowed pin families

No interactive pin. It uses push token state associated with the dashboard/user.

Transport path

Server-side push delivery once the widget is initialized with tokens.

Operational limits

If the dashboard has no registered notification token the server rejects delivery

Service authority boundary

Notification depends on dashboard push registration, token validity and project-level permission to emit alerts.

Who validates it: backend / project policy / dashboard grants.

What the board sees: the resulting write, notification or text payload, not the visual tile itself.

Configuration surface

  • notifyWhenOffline enables connection-loss alerts
  • notifyBody customizes the payload text
  • notifyWhenOfflineIgnorePeriod delays offline alerts
  • priority sets normal/high delivery mode
  • alert copy should stay short and deterministic because push providers can truncate aggressively

Limits and caveats

  • If the dashboard has no registered notification token the server rejects delivery
  • Notification body must pass server-side validation
  • It behaves more like infrastructure than a visible canvas control
  • Alert storms need backend rate limiting because the widget itself has no on-canvas backpressure

Protocol and implementation notes

  • Push delivery only works once the dashboard has a Notification widget and a registered push token for that dashboard.
  • Server-side validation rejects malformed notification bodies and unauthorized notification calls.
  • Avoid treating the widget as a chat stream; it is an alert surface with short message constraints.

Layout notes

Canvas footprint

2 x 2

Default footprint in the Plynx canvas before user resizing.

Resize floor

2 x 2

The minimum size accepted by the app during drag-resize.

Interaction model

Display

Whether the user edits state directly or only reads it.

Related widgets

Email

Service widget for sending mail notifications and alert summaries.

RTC

Background time-sync widget that exposes server time to firmware logic.

Bridge

Background bridge for writing pins on another device or token context.

Webhook

Non-visual automation widget for relaying events to external HTTP endpoints.