Texecom Event Schemas

JSON Schema Documentation

Access Key Delete Payload

Payload emitted when the observer lambda intercepts a DELETE /api/settings/users/access_keys/{key_id} message. No key body is present in a delete — only the identifiers needed to locate the slot.

$idhttps://schemas.texecom-prod.com/v2/events/payload/cloud/internal/access_key/delete/v1.0.0.json
$schemahttp://json-schema.org/draft-07/schema

Properties

NameType
serialString
hardwareIdString
keySlotIdString
userIdString

serial

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

hardwareId

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

keySlotId

Description Key slot identifier (key1–key20) that was cleared.
TypeString
Required Yes

userId

Description The user the deleted key was associated with (user1–user10).
TypeString
Required Yes

Schema

{
    "$id": "https://schemas.texecom-prod.com/v2/events/payload/cloud/internal/access_key/delete/v1.0.0.json",
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Access Key Delete Payload",
    "description": "Payload emitted when the observer lambda intercepts a DELETE /api/settings/users/access_keys/{key_id} message. No key body is present in a delete — only the identifiers needed to locate the slot.",
    "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"
        },
        "keySlotId": {
            "description": "Key slot identifier (key1–key20) that was cleared.",
            "type": "string"
        },
        "userId": {
            "description": "The user the deleted key was associated with (user1–user10).",
            "type": "string"
        }
    },
    "required": [
        "serial",
        "hardwareId",
        "keySlotId",
        "userId"
    ],
    "additionalProperties": false
}