Texecom Event Schemas

JSON Schema Documentation

Write Veritas Pro Alert Setting

Payload emitted when the observer lambda intercepts a PUT /api/settings/alerts/{id} MQTT message. Captures which alert setting was written and the new values.

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

Properties

NameType
hardwareIdString
serialString
alertSettingIdString
confirmedAlarmObject
initiatedByString
timestampString

hardwareId

Description Hardware ID on which the alert setting is being written
TypeString
Required Yes
Format uuid

serial

Description Serial number of the hardware on which the alert setting is being written
TypeString
Required Yes

alertSettingId

Description The alert setting identifier from the path parameter (e.g. confirmed_alarm). Maps to {id} in settings/alerts/{id}.
TypeString
Required Yes

confirmedAlarm

Description The written confirmed alarm settings
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 write request (e.g. app)
TypeString
Required Yes

timestamp

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

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/alerts/setting/write/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Write Veritas Pro Alert Setting",
    "description": "Payload emitted when the observer lambda intercepts a PUT /api/settings/alerts/{id} MQTT message. Captures which alert setting was written and the new values.",
    "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 on which the alert setting is being written",
            "format": "uuid"
        },
        "serial": {
            "type": "string",
            "description": "Serial number of the hardware on which the alert setting is being written"
        },
        "alertSettingId": {
            "type": "string",
            "description": "The alert setting identifier from the path parameter (e.g. confirmed_alarm). Maps to {id} in settings/alerts/{id}."
        },
        "confirmedAlarm": {
            "description": "The written confirmed alarm settings",
            "$ref": "#/definitions/confirmedAlarm"
        },
        "initiatedBy": {
            "type": "string",
            "description": "Actor or source of the write request (e.g. app)"
        },
        "timestamp": {
            "type": "string",
            "description": "When the write event was emitted",
            "format": "date-time"
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "alertSettingId",
        "confirmedAlarm",
        "initiatedBy",
        "timestamp"
    ],
    "additionalProperties": false
}