Skip to main content

AlertDeviceAssigned

Emitted when an alert becomes active on a device, one event per 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.
alertUidstringUnique identifier for each alert across system
deviceIdentityHashstringServer-generated unique identifier of the device, used as the public-facing identifier in the REST API.
type"Alert.AlertDeviceAssigned" (literal)Fully-qualified event type discriminator (e.g. Device.DeviceConnectionAdded).
originatorobjectActor that initiated the action behind this event. Omitted for system-triggered events.
originator.accountIdnumberNumeric identifier of the account that initiated the action.
originator.organizationUidstringOrganization on whose behalf the action was initiated.
originator.policyUidstringPolicy under which the action was initiated, if applicable.

Example

{
"id": "string",
"kind": "domain",
"type": "Alert.AlertDeviceAssigned",
"payload": {
"owner": {
"ownershipType": "organization",
"organizationUid": "a50acc53xxxxxxxxxxxxxxxx8f975173",
"parentCompanyUid": "8b434f9cxxxxxxxxxxxxxxxx61679ca2"
},
"alertUid": "9a5f4b89xxxxxxxxxxxxxxxx9e0b4afc",
"deviceIdentityHash": "704404ffxxxxxxxxxxxxxxxxc0493bae",
"type": "Alert.AlertDeviceAssigned",
"originator": {
"accountId": 5278,
"organizationUid": "b921ac89xxxxxxxxxxxxxxxx5d530b01",
"policyUid": "94013b44xxxxxxxxxxxxxxxxd5cba551"
}
}
}

Shape

{
"id": "string",
"kind": "domain",
"type": "Alert.AlertDeviceAssigned",
"payload": {
"owner": {
"ownershipType": "organization",
"organizationUid": "string",
"parentCompanyUid": "string"
},
"alertUid": "string",
"deviceIdentityHash": "string",
"type": "Alert.AlertDeviceAssigned",
"originator?": {
"accountId?": "number",
"organizationUid?": "string",
"policyUid?": "string"
}
}
}