Alert Acknowledge Payload
Payload emitted when an alert acknowledge command is sent. Identifies the hardware, the alert category being acknowledged, and the actor who initiated the action.
| $id | https://schemas.texecom-prod.com/v2/events/payload/alerts/acknowledge/v1.0.0.json |
|---|
| $schema | http://json-schema.org/draft-07/schema |
|---|
Properties
hardwareId
| Description |
Hardware ID for which alerts are being acknowledged |
| Type | String |
|---|
| Required |
Yes |
| Format |
uuid |
serial
| Description |
Serial number of the hardware for which alerts are being acknowledged |
| Type | String |
|---|
| Required |
Yes |
alertCategory
| Description |
Firmware AlertCategory discriminated union |
|
| Type | One of: | Object |
| Object |
| Object |
| Object |
| Object |
| String |
| Required |
Yes |
alertCategory.0
alertCategory.0.alarm
| Type | String |
|---|
| Enum |
- intruder
- entry
- fire
- panic
- medical
- gas
- tamper
- aux_fault
|
alertCategory.1
alertCategory.1.fault
| Type | String |
|---|
| Enum |
- ats
- atp_primary
- atp_secondary
- aux_power
- bell
- lid
- zone
- battery
- battery_low
- battery_flat
- mains
- internal12v
- aux12v
- aux12v_fuse
- bell12v_fuse
- speaker
|
alertCategory.2
alertCategory.2.tamper
alertCategory.3
alertCategory.3.warning
| Type | String |
|---|
| Enum |
- mqtt_disconnected
- unregistered
- exit_warning
- arm_failed
|
alertCategory.4
alertCategory.4.information
| Type | String |
|---|
| Enum |
- configured
- mqtt_connected
- panel_connected
- registered
- registration_in_progress
|
alertCategory.5
| Type | String |
|---|
| Enum |
- unknown
- alarms
- faults
- tampers
- warnings
- informations
|
initiatedBy
| Description |
Actor for the acknowledgment |
| Type | String |
|---|
| Required |
Yes |
timestamp
| Description |
When the acknowledge action was triggered |
| Type | String |
|---|
| Required |
Yes |
| Format |
date-time |
Schema
{
"$id": "https://schemas.texecom-prod.com/v2/events/payload/alerts/acknowledge/v1.0.0.json",
"$schema": "http://json-schema.org/draft-07/schema",
"title": "Alert Acknowledge Payload",
"description": "Payload emitted when an alert acknowledge command is sent. Identifies the hardware, the alert category being acknowledged, and the actor who initiated the action.",
"definitions": {
"alertCategory": {
"description": "Firmware AlertCategory discriminated union",
"oneOf": [
{
"type": "object",
"properties": {
"alarm": {
"type": "string",
"enum": [
"intruder",
"entry",
"fire",
"panic",
"medical",
"gas",
"tamper",
"aux_fault"
]
}
},
"required": [
"alarm"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"fault": {
"type": "string",
"enum": [
"ats",
"atp_primary",
"atp_secondary",
"aux_power",
"bell",
"lid",
"zone",
"battery",
"battery_low",
"battery_flat",
"mains",
"internal12v",
"aux12v",
"aux12v_fuse",
"bell12v_fuse",
"speaker"
]
}
},
"required": [
"fault"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"tamper": {
"type": "string",
"enum": [
"lid",
"zone",
"bell"
]
}
},
"required": [
"tamper"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"warning": {
"type": "string",
"enum": [
"mqtt_disconnected",
"unregistered",
"exit_warning",
"arm_failed"
]
}
},
"required": [
"warning"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"information": {
"type": "string",
"enum": [
"configured",
"mqtt_connected",
"panel_connected",
"registered",
"registration_in_progress"
]
}
},
"required": [
"information"
],
"additionalProperties": false
},
{
"type": "string",
"enum": [
"unknown",
"alarms",
"faults",
"tampers",
"warnings",
"informations"
]
}
]
}
},
"type": "object",
"properties": {
"hardwareId": {
"type": "string",
"description": "Hardware ID for which alerts are being acknowledged",
"format": "uuid"
},
"serial": {
"type": "string",
"description": "Serial number of the hardware for which alerts are being acknowledged"
},
"alertCategory": {
"description": "Firmware AlertCategory discriminated union",
"$ref": "#/definitions/alertCategory"
},
"initiatedBy": {
"type": "string",
"description": "Actor for the acknowledgment"
},
"timestamp": {
"type": "string",
"description": "When the acknowledge action was triggered",
"format": "date-time"
}
},
"required": [
"hardwareId",
"serial",
"alertCategory",
"initiatedBy",
"timestamp"
],
"additionalProperties": false
}