Device Notifications

Introduction to Device Notifications

A trait notification is an event published by the device to communicate transient information to the user (e.g. low battery, device locked/unlocked audits, etc.).

There are 2 different types of notifications:

• WARNING notifications are critical alerts that require user attention and potentially action to address. An example would be warningBatteryLevel event publishing when battery level is low or critical to warn user to replace batteries.
• INFO notifications are informational events published for user to know what is happening with their device. An example would be the infoUserAccessLockEvent notification publishing an audit event when a credential is presented to the lock.

Trait Notification Flows

Notification Reported Events

See device events for information on subscribing to webhooks or submitting event queries.

DEVICE_NOTIFICATION_REPORTED Event

Event that is published when the device publishes a notification regardless of the trait type (standard or bulk data) or notification type (info or warning).

 
{
    "eventType": "DEVICE_NOTIFICATION_REPORTED",
    "notifications": [
        {
            "category": "notification",
            "notificationName": "warningBatteryLevel",
            "notificationType": "WARNING",
            "type": "notification reported",
            "createdAt": "2024-12-20T14:49:55.000Z",
            "sampledAt": "2024-12-20T14:49:39.663Z",
            "installationId": "819cd607-aede-482e-9aa0-8b65d420e300",
            "deviceId": "9a8f6104-6c50-476e-90ee-16b9a2dafc8d",
            "traitName": "batteryV1",
            "message": "Device battery level is CRITICAL.",
            "id": "92197db2-63a4-4832-9a20-59dd188b6504",
            "details": {
                "batteryLevel": "CRITICAL"
            }
        }
    ]
}

DEVICE_NOTIFICATION_REPORTED Event Fields