Texecom Event Schemas

JSON Schema Documentation

Read Veritas Pro Alert Settings

Payload emitted when the observer lambda intercepts a GET /api/settings/alerts MQTT message. Returns the full alert settings configuration from the panel.

$idhttps://schemas.texecom-prod.com/v2/events/payload/alerts/setting/read/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
hardwareIdString
serialString
confirmedAlarmObject
initiatedByString
timestampString

hardwareId

Description Hardware ID from which alert settings are being read
TypeString
Required Yes
Format uuid

serial

Description Serial number of the hardware from which alert settings are being read
TypeString
Required Yes

confirmedAlarm

Description Confirmed alarm settings read from the panel
TypeObject
Required Yes

Properties

NameType
enabledBoolean
timeoutSecondsInteger

confirmedAlarm.enabled

Description Whether confirmed alarm mode is enabled on the panel
TypeBoolean
Required Yes

confirmedAlarm.timeoutSeconds

Description Confirmation timeout window in seconds. UEM-normalised name for firmware timeout_s field.
TypeInteger
Required Yes

initiatedBy

Description Actor or source of the read request (e.g. app)
TypeString
Required Yes

timestamp

Description When the read event was emitted
TypeString
Required Yes
Format date-time

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/alerts/setting/read/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Read Veritas Pro Alert Settings",
    "description": "Payload emitted when the observer lambda intercepts a GET /api/settings/alerts MQTT message. Returns the full alert settings configuration from the panel.",
    "definitions": {
        "confirmedAlarm": {
            "type": "object",
            "properties": {
                "enabled": {
                    "type": "boolean",
                    "description": "Whether confirmed alarm mode is enabled on the panel"
                },
                "timeoutSeconds": {
                    "type": "integer",
                    "minimum": 0,
                    "description": "Confirmation timeout window in seconds. UEM-normalised name for firmware timeout_s field."
                }
            },
            "required": [
                "enabled",
                "timeoutSeconds"
            ],
            "additionalProperties": false
        }
    },
    "type": "object",
    "properties": {
        "hardwareId": {
            "type": "string",
            "description": "Hardware ID from which alert settings are being read",
            "format": "uuid"
        },
        "serial": {
            "type": "string",
            "description": "Serial number of the hardware from which alert settings are being read"
        },
        "confirmedAlarm": {
            "description": "Confirmed alarm settings read from the panel",
            "$ref": "#/definitions/confirmedAlarm"
        },
        "initiatedBy": {
            "type": "string",
            "description": "Actor or source of the read request (e.g. app)"
        },
        "timestamp": {
            "type": "string",
            "description": "When the read event was emitted",
            "format": "date-time"
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "confirmedAlarm",
        "initiatedBy",
        "timestamp"
    ],
    "additionalProperties": false
}