Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Notifications

Get a notification

get/notifications/{id}

Path parameters

idstring required

Edition ID

Response

Notification result

idstring uuid
timestampstring date-time
createTimestampstring date-time
sentTimestampstring date-time nullable
alertIdstring uuid nullable
alertTypestring
actorIdstring
actorNamestring
actorTypestring
actorAccountIdstring
userIdstring
accountIdstring
readboolean
status'pending' | 'sent' | 'outsideUsersSchedule' | 'notificationsDisabled' | 'noNotificationActions' | 'sendingFailed' | 'throttled' | 'unableToGetSettings'
category'health' | 'video' | 'operational' | 'audit' | 'job' | 'security' | 'sharing'
descriptionstring
notificationActionsstring[]
dataSchemasstring[]
dataobject

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "timestamp": "2021-04-22T00:00:00.000+00:00",
  "createTimestamp": "2021-04-22T00:00:00.000+00:00",
  "sentTimestamp": "2021-04-22T00:00:00.000+00:00",
  "alertId": "16cf0993-9705-406f-a17b-92fbe6836247",
  "alertType": "lineCrossing",
  "actorId": "d22d1939-2e14-434b-8185-d324be6cf363",
  "actorName": "Front Door",
  "actorType": "device",
  "actorAccountId": "00011557",
  "userId": "ca0de584",
  "accountId": "00011557",
  "status": "sent",
  "description": "Line crossing detected on \"Front Door\"",
  "notificationActions": [
    "email",
    "push",
    "webapp",
    "gui",
    "sms"
  ]
}