Domain Model
Alert
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| externalConnectionId | string | No | — | ID of the associated external connection |
| siteId | string | Yes | — | ID of the associated site |
| systemId | string | No | — | ID of the associated system |
| assetId | string | No | — | ID of the associated asset |
| alertType | enum(access_denied, door_held, door_forced, tamper_detected, connection_lost, system_offline, low_battery, health_check_failed, fault_detected, unauthorized_access, configuration_change, other) | Yes | — | Alert type |
| alertSeverity | enum(informational, warning, error, critical) | Yes | — | Alert severity |
| disposition | enum(open, acknowledged, investigating, resolved, false_alarm, auto_resolved) | Yes | — | Disposition |
| sourceEventId | string | No | — | ID of the associated source event |
| sourceEventJson | unknown | No | — | Source event json |
| message | string | Yes | — | Message |
| occurredAt | string.date-time | Yes | — | Occurred at |
| receivedAt | string.date-time | Yes | — | Received at |
| incidentId | string | No | — | ID of the associated incident |
| operatorNotes | string | No | — | Operator notes |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| externalConnectionId | string | No | — | ID of the associated external connection |
| siteId | string | Yes | — | ID of the associated site |
| systemId | string | No | — | ID of the associated system |
| assetId | string | No | — | ID of the associated asset |
| alertType | enum(access_denied, door_held, door_forced, tamper_detected, connection_lost, system_offline, low_battery, health_check_failed, fault_detected, unauthorized_access, configuration_change, other) | Yes | — | Alert type |
| alertSeverity | enum(informational, warning, error, critical) | Yes | — | Alert severity |
| disposition | enum(open, acknowledged, investigating, resolved, false_alarm, auto_resolved) | Yes | "open" | Disposition |
| sourceEventId | string | No | — | ID of the associated source event |
| sourceEventJson | unknown | No | — | Source event json |
| message | string | Yes | — | Message |
| occurredAt | string.date-time | Yes | — | Occurred at |
| receivedAt | string.date-time | Yes | "2026-10-24T02:19:57.902Z" | Received at |
| incidentId | string | No | — | ID of the associated incident |
| operatorNotes | string | No | — | Operator notes |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| externalConnectionId | string | No | — | ID of the associated external connection |
| siteId | string | No | — | ID of the associated site |
| systemId | string | No | — | ID of the associated system |
| assetId | string | No | — | ID of the associated asset |
| alertType | enum(access_denied, door_held, door_forced, tamper_detected, connection_lost, system_offline, low_battery, health_check_failed, fault_detected, unauthorized_access, configuration_change, other) | No | — | Alert type |
| alertSeverity | enum(informational, warning, error, critical) | No | — | Alert severity |
| disposition | enum(open, acknowledged, investigating, resolved, false_alarm, auto_resolved) | No | — | Disposition |
| sourceEventId | string | No | — | ID of the associated source event |
| sourceEventJson | unknown | No | — | Source event json |
| message | string | No | — | Message |
| occurredAt | string.date-time | No | — | Occurred at |
| incidentId | string | No | — | ID of the associated incident |
| operatorNotes | string | No | — | Operator notes |