Texecom Event Schemas

JSON Schema Documentation

Arming Command — Arm Initiated Payload

Payload schema for arming.command.arm_initiated events. Emitted when the Arming Lambda intercepts an arm command on MQTT topic commands/arming/arm.

$idhttps://schemas.texecom-prod.com/v2/events/payload/arming/command/arm_initiated/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
hardwareIdString
serialString
partitionIdString
omitZonesArray
omitFaultsArray
initiatedByString
timestampString

hardwareId

Description Hardware ID of the target panel.
TypeString
Required Yes
Format uuid

serial

Description Serial number of the target panel.
TypeString
Required Yes

partitionId

Description Target partition identifier, mapped from firmware ArmPart.
TypeString
Required Yes
Enum
  • part1
  • part2
  • part3
  • part4
  • part5
  • full

omitZones

Description Zone IDs bypassed for this arming session. Mapped from firmware omit_zones.
TypeArray
Required No

omitFaults

Description Fault categories ignored for this arming session. Mapped from firmware omit_faults.
TypeArray
Required No

initiatedBy

Description Originating actor. Typically 'app' for initial commands.
TypeString
Required Yes

timestamp

Description Business timestamp for the observed event (ISO 8601).
TypeString
Required Yes
Format date-time

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/arming/command/arm_initiated/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Arming Command — Arm Initiated Payload",
    "description": "Payload schema for arming.command.arm_initiated events. Emitted when the Arming Lambda intercepts an arm command on MQTT topic commands/arming/arm.",
    "type": "object",
    "properties": {
        "hardwareId": {
            "type": "string",
            "format": "uuid",
            "description": "Hardware ID of the target panel."
        },
        "serial": {
            "type": "string",
            "description": "Serial number of the target panel."
        },
        "partitionId": {
            "type": "string",
            "description": "Target partition identifier, mapped from firmware ArmPart.",
            "enum": [
                "part1",
                "part2",
                "part3",
                "part4",
                "part5",
                "full"
            ]
        },
        "omitZones": {
            "type": "array",
            "description": "Zone IDs bypassed for this arming session. Mapped from firmware omit_zones.",
            "items": {
                "type": "string"
            }
        },
        "omitFaults": {
            "type": "array",
            "description": "Fault categories ignored for this arming session. Mapped from firmware omit_faults.",
            "items": {
                "type": "string"
            }
        },
        "initiatedBy": {
            "type": "string",
            "description": "Originating actor. Typically 'app' for initial commands."
        },
        "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Business timestamp for the observed event (ISO 8601)."
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "partitionId",
        "initiatedBy",
        "timestamp"
    ],
    "additionalProperties": false
}