Skip to main content

AlertArchived

Emitted when a user resolves the whole alert. The alert's devices stay assigned; consumers tracking per-device alert state should treat all previously assigned devices as no longer alerting.

Payload

FieldTypeRequiredDescription
alertRuleUidstring | nullIdentifier of the alert rule the alert was created from. null only on historical events emitted before this field existed.
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
type"Alert.AlertArchived" (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.AlertArchived",
"payload": {
"alertRuleUid": "53d4d78bxxxxxxxxxxxxxxxxcbf7bdf8",
"owner": {
"ownershipType": "organization",
"organizationUid": "e438e1edxxxxxxxxxxxxxxxxc6c85a94",
"parentCompanyUid": "fe22bc67xxxxxxxxxxxxxxxx8614ac97"
},
"alertUid": "46baebc6xxxxxxxxxxxxxxxx1ca0e396",
"type": "Alert.AlertArchived",
"originator": {
"accountId": 5031,
"organizationUid": "ddf25bddxxxxxxxxxxxxxxxx1427f5c0",
"policyUid": "d02d9b1bxxxxxxxxxxxxxxxx6e651964"
}
}
}

Shape

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