This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk/realtime / RealtimeNotification

RealtimeNotification ​

Notification for the user received on coreTopics.notification().

Properties ​

actionUrl? ​

optional actionUrl?: string

Suggested destination for the notification's action (path or URL).


category ​

category: string

Business category, e.g. 'bet', 'payment', 'bonus', 'system'.


createdAt ​

createdAt: string

Creation instant (ISO 8601).


data? ​

optional data?: Record<string, unknown>

Extra event data, with the keys as the gateway sends them.


id ​

id: string

Notification id.


message ​

message: string

Notification text.


title ​

title: string

Short title.


type ​

type: string & object | "error" | "success" | "warning" | "info"

Severity: 'info', 'success', 'warning' or 'error'; the gateway may send another value, handle the default case.