Skip to main content

Subscribe to real-time notification events (banners and errors).

GET 
/api/v2/events/notifications

Opens an SSE stream that fires whenever the system needs to communicate a message to the user — errors, warnings, informational banners, or success confirmations. Each event is a NotificationEvent with kind, severity, category, message, and optional entity reference.

Request​

Responses​

SSE stream — fires NotificationEvent for banners and errors

Schema

    category stringrequired

    Category tag for filtering/grouping (e.g. "storage", "sync", "config").

    entityId stringnullable

    Optional: ID of the related entity (e.g. catalog_id, device_id).

    entityType stringnullable

    Optional: what domain entity this relates to (e.g. "delivery", "device").

    id stringrequired

    Unique ID for this notification instance.

    kind NotificationKindrequired

    Possible values: [banner, error]

    Discriminator: banner (informational) vs error (failure).

    message stringrequired

    Human-readable message to display. In the future, may be a translation key.

    persistent booleanrequired

    If true, stays on screen until user dismisses. If false, auto-hides.

    severity NotificationSeverityrequired

    Possible values: [info, warning, error, success]

    Visual severity for UI styling.

    timestamp stringrequired

    ISO 8601 timestamp.

Loading...