ADT · JSON Structure

Platform Api Event Structure

A security event or alarm history entry.

Type: object Properties: 6
Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Event is a JSON Structure definition published by ADT, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id type description deviceId timestamp userId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-structure/platform-api-event-structure.json",
  "name": "Event",
  "description": "A security event or alarm history entry.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the event.",
      "example": "evt-001"
    },
    "type": {
      "type": "string",
      "description": "Type of security event.",
      "enum": [
        "alarm",
        "arm",
        "disarm",
        "sensor_open",
        "sensor_close",
        "motion",
        "video",
        "panic"
      ],
      "example": "alarm"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the event.",
      "example": "Motion detected at front door"
    },
    "deviceId": {
      "type": "string",
      "description": "ID of the device that triggered the event.",
      "example": "dev-001"
    },
    "timestamp": {
      "type": "datetime",
      "description": "Timestamp when the event occurred.",
      "example": "2025-03-15T14:30:00Z"
    },
    "userId": {
      "type": "string",
      "description": "ID of the user associated with the event.",
      "example": "usr-001"
    }
  }
}