Skip to main content

SystemLogSocketConnectionFailed

Reported when a device fails to establish its socket connection to the platform.

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.SocketConnectionFailed" (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.
errorMessagestring
socketNamestring

Example

{
"id": "string",
"kind": "systemLog",
"type": "Device.SystemLog.SocketConnectionFailed",
"payload": {
"owner": {
"ownershipType": "organization",
"organizationUid": "6a276bd6xxxxxxxxxxxxxxxx35636793",
"parentCompanyUid": "d71b7bf7xxxxxxxxxxxxxxxxa989659b"
},
"type": "Device.SystemLog.SocketConnectionFailed",
"deviceIdentityHash": "32032d97xxxxxxxxxxxxxxxx3554134b",
"receivedAt": "string",
"recordedAt": "string",
"source": "online",
"errorMessage": "Something went wrong",
"socketName": "Example Name"
}
}

Shape

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