Skip to main content

SystemLogSocketConnected

Reported when a device establishes its socket connection to the platform.

Payload​

FieldTypeRequiredDescription
ownerobject✅Ownership 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.organizationUidstring✅UID of the organization that owns the event.
owner.parentCompanyUidstring✅UID of the owning organization's parent company.
type"Device.SystemLog.SocketConnected" (literal)✅Fully-qualified event type discriminator (e.g. Device.DeviceConnectionAdded).
deviceIdentityHashstring✅Server-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.
socketNamestring—

Example​

{
"id": "string",
"kind": "systemLog",
"type": "Device.SystemLog.SocketConnected",
"payload": {
"owner": {
"ownershipType": "organization",
"organizationUid": "4a1e9718xxxxxxxxxxxxxxxx704171d2",
"parentCompanyUid": "fee9211exxxxxxxxxxxxxxxx60f00e4c"
},
"type": "Device.SystemLog.SocketConnected",
"deviceIdentityHash": "12234068xxxxxxxxxxxxxxxxe2119814",
"receivedAt": "string",
"recordedAt": "string",
"source": "online",
"socketName": "Example Name"
}
}

Shape​

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