Skip to main content
Version: Next

SentNotification

One target-specific notification delivery record, including delivery and acknowledgement state.

acknowledgedOnstring<date-time>

Time the target acknowledged the notification.

acknowledgementstring

Optional JSON acknowledgement value serialized as text.

deliveredOnstring<date-time>

Time the target marked the notification delivered.

errorstring

Delivery error detail when sending failed.

idinteger<int64>

Server-assigned numeric delivery-record identifier.

Example: 42
message object

Typed notification message; its discriminator selects email, push, or another installed message subtype.

type string

Typed notification message; its discriminator selects email, push, or another installed message subtype.

Possible values: []

namestring

Human-readable notification name.

Example: High temperature alert
realmstringrequired

Realm associated with the delivery record.

Example: building
sentOnstring<date-time>

Time the notification was sent or attempted.

sourcestringrequired

Kind of actor that created the notification.

Possible values: [INTERNAL, CLIENT, GLOBAL_RULESET, REALM_RULESET, ASSET_RULESET]

sourceIdstring

Identifier of the user, rule, or component that created the notification.

targetstringrequired

Kind of delivery target.

Possible values: [REALM, USER, ASSET, CUSTOM]

targetIdstringrequired

User, asset, realm, or custom target identifier.

typestringrequired

Notification message type discriminator.

Example: push
SentNotification
{
"acknowledgedOn": "2024-07-29T15:51:28.071Z",
"acknowledgement": "string",
"deliveredOn": "2024-07-29T15:51:28.071Z",
"error": "string",
"id": 42,
"message": {
"type": "string"
},
"name": "High temperature alert",
"realm": "building",
"sentOn": "2024-07-29T15:51:28.071Z",
"source": "INTERNAL",
"sourceId": "string",
"target": "REALM",
"targetId": "string",
"type": "push"
}