Arming Command — Arm Completed Payload

Payload schema for arming.command.arm_completed events. Emitted when the panel confirms arm success or reports failure. Shares correlationId with the corresponding arm_initiated event.

$id	https://schemas.texecom-prod.com/v2/events/payload/arming/command/arm_completed/v1.0.0.json
$schema	http://json-schema.org/draft-07/schema

Properties

Name		Type
hardwareId		String
serial		String
partitionId		String
outcome		String
finalState		String
failureReason		[string, null]
initiatedBy		String
timestamp		String

---

hardwareId

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

serial

Description	Serial number of the target panel.
Type	String
Required	Yes

partitionId

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

outcome

Description	Result of the arm command.
Type	String
Required	Yes
Enum	armed failed

finalState

Description	Panel arming state after command execution, mapped from firmware ArmState.
Type	String
Required	Yes
Enum	disarmed exiting finalising armed entry

failureReason

Description	Reason for failure when outcome is 'failed'. Null on success.
Type	[string, null]
Required	No

initiatedBy

Description	Originating actor. Typically 'panel' for completion events.
Type	String
Required	Yes

timestamp

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

---

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/arming/command/arm_completed/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Arming Command — Arm Completed Payload",
    "description": "Payload schema for arming.command.arm_completed events. Emitted when the panel confirms arm success or reports failure. Shares correlationId with the corresponding arm_initiated event.",
    "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"
            ]
        },
        "outcome": {
            "type": "string",
            "description": "Result of the arm command.",
            "enum": [
                "armed",
                "failed"
            ]
        },
        "finalState": {
            "type": "string",
            "description": "Panel arming state after command execution, mapped from firmware ArmState.",
            "enum": [
                "disarmed",
                "exiting",
                "finalising",
                "armed",
                "entry"
            ]
        },
        "failureReason": {
            "type": [
                "string",
                "null"
            ],
            "description": "Reason for failure when outcome is 'failed'. Null on success.",
            "default": null
        },
        "initiatedBy": {
            "type": "string",
            "description": "Originating actor. Typically 'panel' for completion events."
        },
        "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Business timestamp for the observed event (ISO 8601)."
        }
    },
    "required": [
        "hardwareId",
        "serial",
        "partitionId",
        "outcome",
        "finalState",
        "initiatedBy",
        "timestamp"
    ],
    "additionalProperties": false
}