ADT · Schema

Automation

An automation rule or smart home scene.

Access ControlAutomationHome SecurityIoTMonitoringSecuritySmart HomeFortune 1000

Properties

Name Type Description
id string Unique identifier of the automation.
name string Display name of the automation.
trigger string What triggers this automation.
enabled boolean Whether the automation is currently active.
actions array List of actions performed by this automation.
View JSON Schema on GitHub

JSON Schema

platform-api-automation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-schema/platform-api-automation-schema.json",
  "title": "Automation",
  "description": "An automation rule or smart home scene.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the automation.",
      "example": "auto-001"
    },
    "name": {
      "type": "string",
      "description": "Display name of the automation.",
      "example": "Arm Away at Night"
    },
    "trigger": {
      "type": "string",
      "description": "What triggers this automation.",
      "enum": [
        "schedule",
        "alarm",
        "sensor",
        "geofence",
        "manual"
      ],
      "example": "schedule"
    },
    "enabled": {
      "type": "boolean",
      "description": "Whether the automation is currently active.",
      "example": true
    },
    "actions": {
      "type": "array",
      "description": "List of actions performed by this automation.",
      "items": {
        "type": "object"
      }
    }
  }
}