Access Key Learn Status Payload

Payload emitted after a learn mode session initiated via PUT /api/commands/users/learn. keySlotId, keyValue, and usage are only present when group is key_added.

$id	https://schemas.texecom-prod.com/v2/events/payload/cloud/internal/access_key/learn_status/v1.0.0.json
$schema	http://json-schema.org/draft-07/schema

Properties

Name		Type
serial		String
hardwareId		String
userId		String
group		String
timeoutSeconds		Integer
keySlotId		String
keyValue		Integer
usage	One of:	String
		Object
		Object

---

serial

Description	Panel serial number extracted from the MQTT topic path (device/{serial}/...).
Type	String
Required	Yes

hardwareId

Description	Panel primary key in the device service DB, resolved via serial lookup (device.hardware.hardware_id).
Type	String
Required	Yes
Format	uuid

userId

Description	User the learn session was initiated for. Maps to LearnParams.user_id.
Type	String
Required	Yes

group

Description	Outcome of the learn mode session.
Type	String
Required	Yes
Enum	key_added duplicate_key no_free_slots learn_timeout error

timeoutSeconds

Description	Configured duration the system waited for a key to be presented. Maps to LearnParams.timeout.
Type	Integer
Required	Yes

keySlotId

Description	Slot the newly learned key was assigned to. Present only when group is key_added.
Type	String
Required	No

keyValue

Description	Raw numeric value of the learned credential. Present only when group is key_added.
Type	Integer
Required	No

usage

Description	Configured usage assigned to the key. Present only when group is key_added. Maps to LearnParams.usage.
Type	One of:	String
		Object
		Object
Required	No

usage.0

Type	String
Enum	disarm

usage.1

Type	Object

usage.1.arm

Type	String

usage.2

Type	Object

usage.2.arm_toggle

Type	String

---

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/cloud/internal/access_key/learn_status/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Access Key Learn Status Payload",
    "description": "Payload emitted after a learn mode session initiated via PUT /api/commands/users/learn. keySlotId, keyValue, and usage are only present when group is key_added.",
    "type": "object",
    "properties": {
        "serial": {
            "description": "Panel serial number extracted from the MQTT topic path (device/{serial}/...).",
            "type": "string"
        },
        "hardwareId": {
            "description": "Panel primary key in the device service DB, resolved via serial lookup (device.hardware.hardware_id).",
            "type": "string",
            "format": "uuid"
        },
        "userId": {
            "description": "User the learn session was initiated for. Maps to LearnParams.user_id.",
            "type": "string"
        },
        "group": {
            "description": "Outcome of the learn mode session.",
            "type": "string",
            "enum": [
                "key_added",
                "duplicate_key",
                "no_free_slots",
                "learn_timeout",
                "error"
            ]
        },
        "timeoutSeconds": {
            "description": "Configured duration the system waited for a key to be presented. Maps to LearnParams.timeout.",
            "type": "integer"
        },
        "keySlotId": {
            "description": "Slot the newly learned key was assigned to. Present only when group is key_added.",
            "type": "string"
        },
        "keyValue": {
            "description": "Raw numeric value of the learned credential. Present only when group is key_added.",
            "type": "integer"
        },
        "usage": {
            "description": "Configured usage assigned to the key. Present only when group is key_added. Maps to LearnParams.usage.",
            "oneOf": [
                {
                    "type": "string",
                    "enum": [
                        "disarm"
                    ]
                },
                {
                    "type": "object",
                    "properties": {
                        "arm": {
                            "type": "string"
                        }
                    },
                    "required": [
                        "arm"
                    ],
                    "additionalProperties": false
                },
                {
                    "type": "object",
                    "properties": {
                        "arm_toggle": {
                            "type": "string"
                        }
                    },
                    "required": [
                        "arm_toggle"
                    ],
                    "additionalProperties": false
                }
            ]
        }
    },
    "required": [
        "serial",
        "hardwareId",
        "userId",
        "group",
        "timeoutSeconds"
    ],
    "additionalProperties": false
}