Skip to main content

SystemLogDeviceAlive

Periodic keep-alive reported by a running device.

Payload

FieldTypeRequiredDescription
ownerobjectOwnership envelope identifying the company or organization that owns this event.
owner.ownershipType"organization" (literal)Discriminator for the ownership envelope; always organization for these events.
owner.organizationUidstringUID of the organization that owns the event.
owner.parentCompanyUidstringUID of the owning organization's parent company.
type"Device.SystemLog.DeviceAlive" (literal)Fully-qualified event type discriminator (e.g. Device.DeviceConnectionAdded).
deviceIdentityHashstringServer-generated unique identifier of the device, used as the public-facing identifier in the REST API.
receivedAtstring (date-time)When the platform received the system log.
recordedAtstring (date-time)When the device recorded the system log; present for logs uploaded offline.
source"online" | "offline" (literal)Whether the log arrived over the live device socket or via an offline upload.

Example

{
"id": "string",
"kind": "systemLog",
"type": "Device.SystemLog.DeviceAlive",
"payload": {
"owner": {
"ownershipType": "organization",
"organizationUid": "d5385b44xxxxxxxxxxxxxxxx7994d098",
"parentCompanyUid": "273fe889xxxxxxxxxxxxxxxxde4c6b2c"
},
"type": "Device.SystemLog.DeviceAlive",
"deviceIdentityHash": "e341cf31xxxxxxxxxxxxxxxx87cf3abe",
"receivedAt": "string",
"recordedAt": "string",
"source": "online"
}
}

Shape

{
"id": "string",
"kind": "systemLog",
"type": "Device.SystemLog.DeviceAlive",
"payload": {
"owner": {
"ownershipType": "organization",
"organizationUid": "string",
"parentCompanyUid": "string"
},
"type": "Device.SystemLog.DeviceAlive",
"deviceIdentityHash": "string",
"receivedAt": "string (date-time)",
"recordedAt?": "string (date-time)",
"source": "online | offline"
}
}