API Reference
These docs are for v1.0. Click to read the latest docs for v2.0.

A Konnected Alarm Panel or Alarm Panel Pro needs to be provisioned via this endpoint to specify the device inputs, outputs, and the endpoint for the hub or controller. After this provisioning step, the Alarm Panel will communicate state changes to the endpoint specified, and will respond to state change commands authenticated with the valid token.

All Konnected Alarm Panel devices must be provisioned with a HTTP request from your controller, computer or mobile device on the same network.

Provisioning a HTTP API Endpoint

When provisioning a HTTP API Endpoint, set the endpoint and token fields are required. Example provisioning payload:

{
  "endpoint_type":"rest",
  "endpoint":"http://192.168.1.123:8800/api/konnected",
  "token":"my-service-shared-secret",
  "sensors":[
    {"zone":1},{"zone":2},{"zone":3},{"zone":4},{"zone":6}
   ], 
  "actuators":[
    {"zone":"out", "trigger": 1}
  ],
  "dht_sensors":[
    {"zone":5, "poll_interval":2}
  ]
}

Provisioning an AWS IoT Endpoint

When provisioning an AWS IoT endpoint, the aws object is required. The aws object specifies connection credentials and the MQTT topics that the device will publish and subscribe.

Example provisioning payload for Alarm Panel / ESP8266:

{
  "endpoint_type":"aws_iot",
  "endpoint":"wss://a35zoibxxxxxxx-ats.iot.us-east-1.amazonaws.com/mqtt",
  "aws":{ 
    "token":"TOKEN", 
    "token_signature":"TOKEN_SIGNATURE", 
    "authorizer":"us-east-1",
    "topics":{
      "sensor":"konnected/8840f5209948/sensor",
      "switch":"konnected/8840f5209948/switch",
      "heartbeat":"konnected/8840f5209948/hb"
    }
   },
  "sensors":[
    {"zone":1},{"zone":2},{"zone":3},{"zone":4},{"zone":6}
   ], 
  "actuators":[
    {"zone":"out", "trigger": 1}
  ],
  "dht_sensors":[
    {"zone":5, "poll_interval":2}
  ]
}

Example provisioning payload for the Alarm Panel Pro / ESP32:

{
  "endpoint_type":"aws_iot",
  "endpoint":"a35zoibxxxxxxx-ats.iot.us-east-1.amazonaws.com",
  "aws":{ 
    "certs": {
      "client_cert": "CLIENT_CERT",
      "client_key": "CLIENT_KEY"
    },
    "topics":{
      "sensor":"konnected/8840f5209948/sensor",
      "switch":"konnected/8840f5209948/switch",
      "heartbeat":"konnected/8840f5209948/hb"
    }
   },
  "sensors":[
    {"zone":1},{"zone":2},{"zone":3},{"zone":4},{"zone":6}
   ], 
  "actuators":[
    {"zone":"alarm1", "trigger": 1}
  ],
  "dht_sensors":[
    {"zone":5, "poll_interval":2}
  ]
}
Language
URL