Skip to main content

DeviceConnectionAdded

Emitted when a device's socket connection goes online.

Payload​

FieldTypeRequiredDescription
deviceIdentityHashstring✅Server-generated unique identifier of the device, used as the public-facing identifier in the REST API.
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.DeviceConnectionAdded" (literal)✅Fully-qualified event type discriminator (e.g. Device.DeviceConnectionAdded).
connectionUidstring✅Unique identifier of the connection record.
serverInstanceUidstring✅Identifier of the server instance handling the device connection.

Example​

{
"id": "string",
"kind": "telemetry",
"type": "Device.DeviceConnectionAdded",
"payload": {
"deviceIdentityHash": "3bd36569xxxxxxxxxxxxxxxxd0b918d5",
"owner": {
"ownershipType": "organization",
"organizationUid": "d165d2e6xxxxxxxxxxxxxxxxde86c886",
"parentCompanyUid": "0f678e9exxxxxxxxxxxxxxxxf39c34b4"
},
"type": "Device.DeviceConnectionAdded",
"connectionUid": "083afa93xxxxxxxxxxxxxxxxb90a3754",
"serverInstanceUid": "d07b70eaxxxxxxxxxxxxxxxx32a45331"
}
}

Shape​

{
"id": "string",
"kind": "telemetry",
"type": "Device.DeviceConnectionAdded",
"payload": {
"deviceIdentityHash": "string",
"owner": {
"ownershipType": "organization",
"organizationUid": "string",
"parentCompanyUid": "string"
},
"type": "Device.DeviceConnectionAdded",
"connectionUid": "string",
"serverInstanceUid": "string"
}
}