Texecom Event Schemas

JSON Schema Documentation

walk test stop payload

Emitted when the walk test session ends, whether stopped manually, by the panel, or via timeout.

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

Properties

NameType
panelIdString
walkTestIdString
stoppedByString

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

stoppedBy

Description source of the stop command (e.g. "app")
TypeString
Required Yes

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/walk_test/stop/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "walk test stop payload",
    "description": "Emitted when the walk test session ends, whether stopped manually, by the panel, or via timeout.",
    "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"
        },
        "stoppedBy": {
            "description": "source of the stop command (e.g. \"app\")",
            "type": "string"
        }
    },
    "required": [
        "panelId",
        "walkTestId",
        "stoppedBy"
    ],
    "additionalProperties": false
}