Texecom Event Schemas

JSON Schema Documentation

walk test zone triggered payload

Fired each time a zone sensor (PIR, door contact, etc.) activates during an in-progress walk test.

$idhttps://schemas.texecom-prod.com/v2/events/payload/walk_test/start/zone_triggered/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
panelIdString
walkTestIdString
zoneIdString
zoneNameString
triggerTimestampString

panelId

Description UUID that will give would be identification for panel
TypeString
Required Yes
Format uuid

walkTestId

Description walk test UUID for particular walk test
TypeString
Required Yes
Format uuid

zoneId

Description unique identifier of the triggered zone
TypeString
Required Yes

zoneName

Description human-readable name of the triggered zone
TypeString
Required Yes

triggerTimestamp

Description exact time the zone was triggered
TypeString
Required Yes
Format date-time

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/walk_test/start/zone_triggered/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "walk test zone triggered payload",
    "description": "Fired each time a zone sensor (PIR, door contact, etc.) activates during an in-progress walk test.",
    "type": "object",
    "properties": {
        "panelId": {
            "description": "UUID that will give would be identification for panel",
            "type": "string",
            "format": "uuid"
        },
        "walkTestId": {
            "description": "walk test UUID for particular walk test",
            "type": "string",
            "format": "uuid"
        },
        "zoneId": {
            "description": "unique identifier of the triggered zone",
            "type": "string"
        },
        "zoneName": {
            "description": "human-readable name of the triggered zone",
            "type": "string"
        },
        "triggerTimestamp": {
            "description": "exact time the zone was triggered",
            "type": "string",
            "format": "date-time"
        }
    },
    "required": [
        "panelId",
        "walkTestId",
        "zoneId",
        "zoneName",
        "triggerTimestamp"
    ],
    "additionalProperties": false
}