API Reference

Sections

Notification

A single device notification event.

Notification

detailsjson

JSON Object containing additional notification-specific metadata and context.

deviceobject

Device that published the notification event.

Show child attributes

deviceTimestampstring

ISO 8601 timestamp when notification occurred at the device. Timestamp is a device approximation of UTC time, but may have clock drift of +/- 5 minutes from actual cloud UTC time.

idstring Required

Unique ID of the notification event.

messagestring

The message string indicating what error is being reported by the device. For more information on clearing error codes, see device's published error documentation.

namestring

Name of the notification event that was published.

publishedAtstring

UTC timestamp (ISO 8601 format) when event was published by YP.

severitystring

Notification severity level.

Enum values:

CRITICALINFORMATIONALWARNING

siteobject

Site that owns the device, which published the notification event.

Show child attributes

{
  "details": null,
  "device": {
    "__typename": ""
  },
  "deviceTimestamp": null,
  "id": null,
  "message": null,
  "name": null,
  "publishedAt": null,
  "severity": "CRITICAL",
  "site": {
    "createdAt": null,
    "deviceCount": null,
    "devices": {
      "__typename": ""
    },
    "id": null,
    "integrations": {
      "__typename": ""
    },
    "lastUpdatedAt": null,
    "marketType": "AIRPORT_TRANSPORTATION",
    "name": null,
    "orgId": null,
    "users": {
      "__typename": ""
    }
  }
}

Sections

Notification

NotificationExpand all

Notification