Webhooks

Webhooks are HTTP-based callback mechanisms that enable event-driven communication between the KentixONE system and external services. They are configured and managed in this menu section.

The following parameters are required to implement a webhook:

URL (Uniform Resource Locator) of the external service as communication endpoint
HTTP method for the type of interaction (query, send, modify or delete data)
Content-Type to classify the data format for the external service
The webhook data to be transmitted

The configured webhooks can then be integrated as event handlers in alarm groups or sensor configurations. The management is done clearly in a tabular display that allows creating new and editing existing webhooks.

Available Variables

Alarms

Variable name	Description
$ACTIVE_ALARM_SENSOR_NAME$	Name
$ACTIVE_ALARM_MEASUREMENT_VALUE$	Measured value
$ACTIVE_ALARM_ALARM_VALUE$	Alarm status
$ACTIVE_ALARM_SMS_RECEIVER$	Receiver of alarm SMS

$ALARM_EVENT_ID$	API ID of the corresponding event log entry

note

Possible alarm states are

0: OK
1: Alarm
2: Alarm quittable
3: Warning
4: Pre-alarm
5: Warning quittable

Users

Variable name	Description
$USER_ID$	ID
$USER_NAME$	Name
$USER_FULLNAME$	Full name
$USER_MAIL$	Email address
$USER_RFID_UID$	RFID UID
$USER_RFID_DATA$	RFID DATA
$USER_PIN$	PIN
$USER_UUID$	UUID
$USER_PHONE_NUMBER$	Phone number

Access

Variable name	Description
$ACCESS_STATE$	Booking status
$ACCESS_EVENT_ID$	API ID of the corresponding access log entry

info

Possible booking states are:

0: Ok
1: Remote opening request is invalid
2: Device does not exist
3: Unknown RFID
4: Unknown PIN
5: Two-factor authentication failed
6: Unknown user
7: Booking outside allowed time profile
8: No door permission
9: General error

Devices

Variable name	Description
$DEVICE_ID$	ID
$DEVICE_NAME$	Name
$DEVICE_ADDRESS$	Address
$DEVICE_MAC$	MAC address
$DEVICE_SERIAL$	Serial number
$DEVICE_UUID$	UUID
$DEVICE_TYPE$	Device type

Sensors and Measurements

info

For all sensor variables

"..._VALUE" = Measurement value *"..._ALARM" = Alarm status
"...[number]" = Number/index of digital or analog input.

The square brackets [ ] must not be included

note

Possible alarm states are

0: OK
1: Alarm
2: Alarm quittable
3: Warning
4: Prealarm
5: Warning quittable

Variable name	Description
$INPUT_VALUE[number]$	Measurement value of input
$INPUT_ALARM[number]$	Alarm status of input
$DI_NAME[number]$	Name of digital input

$BATTERY_ALARM$	Battery alarm status
$BATTERY_VALUE$	Battery measurement value
$BATTERY_LEVEL$	Battery level
$BATTERY_VOLTAGE$	Battery voltage

$SIGNAL_LEVEL$	Radio signal reception level
$SIGNAL_STRENGTH$	Radio signal strength dbM

$CO2_VALUE$	CO2 measurement value
$CO2_ALARM$	CO2 alarm status

$DEWPOINT_VALUE$	Dew point measurement value
$DEWPOINT_ALARM$	Dew point alarm status

$HUMIDITY_VALUE$	Rel. humidity measurement value
$HUMIDITY_ALARM$	Rel. humidity alarm status

$LATENCY_VALUE$	Latency measurement value
$LATENCY_ALARM$	Latency alarm status

$MOTION_VALUE$	Motion detection measurement value
$MOTION_ALARM$	Motion detection alarm status

$REED_VALUE$	Door contact measurement value
$REED_ALARM$	Door contact alarm status

$SABOTAGE_VALUE$	Tamper detection measurement value
$SABOTAGE_ALARM$	Tamper detection alarm status

$CONNECTION_VALUE$	Connection status measurement value
$CONNECTION_ALARM$	Connection status alarm status

$EXTPOWER_VALUE$	External power supply measurement value
$EXTPOWER_ALARM$	External power supply alarm status

$TEMPERATURE_VALUE$	Room temperature measurement value
$TEMPERATURE_ALARM$	Room temperature alarm status

$TILT_VALUE$	Tilt sensor measurement value
$TILT_ALARM$	Tilt sensor alarm status

$VIBRATION_VALUE$	Vibration detection measurement value
$VIBRATION_ALARM$	Vibration detection alarm status

$SNMP_VALUE$	SNMP query measurement value
$SNMP_ALARM$	SNMP query alarm status

$AIR_QUALITY_VALUE$	Air quality (environmental monitoring) value
$AIR_QUALITY_ALARM$	Air quality (environmental monitoring) status

$AIR_QUALITY_FIRE_VALUE$	Air quality (early fire detection) value
$AIR_QUALITY_FIRE_ALARM$	Air quality (early fire detection) status

$FIRE_HEAT_VALUE$	Heat sensor measurement value
$FIRE_HEAT_ALARM$	Heat sensor alarm status

$FIRE_TI_VALUE$	IR temperature measurement value
$FIRE_TI_ALARM$	IR temperature alarm status

$FIRE_CO_VALUE$	CO measurement value
$FIRE_CO_ALARM$	CO alarm status

Energy Monitoring

info

For all sensor variables

"..._VALUE" = Measurement value
"..._ALARM" = Alarm status
"...[number]" = Number/index of a phase.

The square brackets [ ] must not be included

note

Possible alarm states are

0: OK
1: Alarm
2: Alarm quittable
3: Warning
4: Prealarm
5: Warning quittable

Variable name	Description
$PHASE_NAME[number]$	Phase name
$PHASE_NUMBER[number]$	Phase number

$VOLTAGE[number]$	Voltage measurement value
$VOLTAGE_ALARM[number]$	Voltage alarm status

$CURRENT[number]$	Current measurement value
$CURRENT_ALARM[number]$	Current alarm status

$POWER_ACTIVE[number]$	Active power measurement value
$POWER_ACTIVE_ALARM[number]$	Active power alarm status

$POWER_REACTIVE[number]$	Reactive power measurement value
$POWER_REACTIVE_ALARM[number]$	Reactive power alarm status

$POWER_APPARENT[number]$	Apparent power measurement value
$POWER_APPARENT_ALARM[number]$	Apparent power alarm status

$POWER_FACTOR[number]$	Power factor measurement value

$FREQUENCY[number]$	Frequency measurement value
$FREQUENCY_ALARM[number]$	Frequency alarm status

$CONSUMPTION[number]$	Consumption measurement value

$FUSE_VALUE[number]$	Fuse measurement value
$FUSE_ALARM[number]$	Fuse alarm status

$RCM_AC$	AC RCM measurement value
$RCM_AC_ALARM$	AC RCM alarm status

$RCM_DC$	DC RCM measurement value
RCM_DC_ALARM$	DC RCM alarm status

$SYNCHRONICITY_VALUE$	Synchronicity measurement value
$SYNCHRONICITY_ALARM$	Synchronicity alarm status

Alarm Groups

Variable name	Description
$GROUP_ID$	ID
$GROUP_NAME$	Name
$GROUP_STATE$	Arm State (0=Disarmed, 1=Armed)
$GROUP_UUID$	UUID
$GROUP_ARMED_PREALARM_COUNT$	Number of armed-active pre-alarms
$GROUP_ARMED_ALARM_COUNT$	Number of pending armed-active alarms
$GROUP_ARMED_QUITABLE_ALARM_COUNT$	Number of acknowledgeable armed-active alarms
$GROUP_ARMED_WARNING_COUNT$	Number of pending armed-active warnings
$GROUP_ARMED_QUITABLE_WARNING_COUNT$	Number of acknowledgeable armed-active warnings

$GROUP_ALWAYS_ALARM_COUNT$	Number of pending always-active alarms
$GROUP_ALWAYS_QUITABLE_ALARM_COUNT$	Number of acknowledgeable always-active alarms
$GROUP_ALWAYS_WARNING_COUNT$	Number of pending always-active warnings
$GROUP_ALWAYS_QUITABLE_WARNING_COUNT$	Number of acknowledgeable always-active warnings

$GROUP_FIRE_ALARM_COUNT$	Number of pending fire alarms
$GROUP_FIRE_QUITABLE_ALARM_COUNT$	Number of acknowledgeable fire alarms
$GROUP_FIRE_WARNING_COUNT$	Number of pending fire warnings
$GROUP_FIRE_QUITABLE_WARNING_COUNT$	Number of acknowledgeable fire warnings

$GROUP_SABOTAGE_ALARM_COUNT$	Number of pending sabotage alarms
$GROUP_SABOTAGE_QUITABLE_ALARM_COUNT$	Number of acknowledgeable sabotage alarms
$GROUP_SABOTAGE_WARNING_COUNT$	Number of pending sabotage warnings
$GROUP_SABOTAGE_QUITABLE_WARNING_COUNT$	Number of acknowledgeable sabotage warnings

$GROUP_SYSTEM_ALARM_COUNT$	Number of pending system message alarms
$GROUP_SYSTEM_QUITABLE_ALARM_COUNT$	Number of acknowledgeable system message alarms
$GROUP_SYSTEM_WARNING_COUNT$	Number of pending system message warnings
$GROUP_SYSTEM_QUITABLE_WARNING_COUNT$	Number of acknowledgeable system message warnings

System

Variable name	Description
$SYSTEM_TIME$	System time in format YYYY-MM-DD HH:MM:SS
$SYSTEM_DATE$	System date in format YYYY-MM-DD
$SYSTEM_UNIXTIME$	System time as UNIX timestamp (UTC)
$SYSTEM_TEMP_UNIT$	Temperature unit (C/F)
$SYSTEM_NAME$	System name
$SYSTEM_ADDRESS$	System address
$SYSTEM_MAC$	System MAC address
$SYSTEM_HOSTNAME$	System hostname
$SYSTEM_SERIAL$	System serial number

Examples

Simple Notification

{
  "alarm-sensor-name": "$ACTIVE_ALARM_SENSOR_NAME$",
  "alarm-sensor-value": "$ACTIVE_ALARM_MEASUREMENT_VALUE$",
  "active-alarm-assignment": "$ACTIVE_ALARM_ALARM_VALUE$"
}

Access

{
  "time": "$SYSTEM_TIME$",
  "user": "$USER_NAME$",
  "rfid": "$USER_RFID_UID$",
  "pin": "$USER_PIN$",
  "state": "$ACCESS_STATE$",
  "door": "$DEVICE_NAME$"
}

MultiSensor

{
  "time": "$SYSTEM_TIME$",
  "device-name": "$DEVICE_NAME$",
  "temperature-unit": "$SYSTEM_TEMP_UNIT$",
  "temperature": "$TEMPERATURE_VALUE$",
  "humidity": "$HUMIDITY_VALUE$",
  "humidity-alarm": "$HUMIDITY_ALARM$",
  "dewpoint": "$DEWPOINT_VALUE$",
  "dewpoint-alarm": "$DEWPOINT_ALARM$",
  "fire-co": "$FIRE_CO_VALUE$",
  "fire-alarm": "$FIRE_CO_ALARM$",
  "fire-air-quality": "$AIR-QUALITY-FIRE-VALUE$",
  "fire-air-quality-alarm": "$AIR_QUALITY_FIRE_ALARM$",
  "intrusion": "$MOTION_VALUE$",
  "intrusion-alarm": "$MOTION_ALARM$",
  "vibration": "$VIBRATION_VALUE$",
  "vibration-alarm": "$VIBRATION_ALARM$",
  "input1-name": "$DI_NAME[1]$",
  "input1_value": "$INPUT_VALUE[1]$",
  "input1-alarm": "$INPUT_ALARM[1]$",
  "input2-name": "$DI_NAME[2]$",
  "input2_value": "$INPUT_VALUE[2]$",
  "input2-alarm": "$INPUT_ALARM[2]$",
  "connection": "$CONNECTION_VALUE$",
  "connection-alarm": "$CONNECTION_ALARM$",
  "external power": "$EXTPOWER_VALUE$",
  "extpower-alarm": "$EXTPOWER_ALARM$"
}

PowerManager

{
  "time": "$SYSTEMTIME$",
  "system-name": "SYSTEM-NAME$",
  "address": "$SYSTEM_ADDRESS$",
  "rcm": {
    "ac": {
      "value": "$RCM_AC$",
      "alarm": "$RCM_AC_ALARM$"
    },
    "dc": {
      "value": "$RCM_DC$",
      "alarm": "$RCM_DC_ALARM$"
    }
  },
  "syncronicity": {
    "value": "$SYNCHRONICITY_VALUE$",
    "alarm": "$SYNCHRONICITY_ALARM$"
  },
  "power_failure": "$POWER_FAILURE_ALARM$",
  "phases": [
    {
      "name": "$PHASE_NAME[1]$",
      "number": "$PHASE_NUMBER[1]$",
      "voltage": {
        "value": "$VOLTAGE[1]$",
        "alarm": "$VOLTAGE_ALARM[1]$"
      },
      "current": {
        "value": "$CURRENT[1]$",
        "alarm": "$CURRENT_ALARM[1]$"
      },
      "power": {
        "active": {
          "value": "$POWER_ACTIVE[1]$",
          "alarm": "$POWER_ACTIVE_ALARM[1]$"
        },
        "reactive": {
          "value": "$POWER_REACTIVE[1]$",
          "alarm": "$POWER_REACTIVE_ALARM[1]$"
        },
        "apparent": {
          "value": "$POWER_APPARENT[1]$",
          "alarm": "$POWER_APPARENT_ALARM[1]$"
        },
        "factor": {
          "value": "$POWER_FACTOR[1]$"
        }
      },
      "frequency": {
        "value": "$FREQUENCY[1]$",
        "alarm": "$FREQUENCY_ALARM[1]$"
      },
      "consumption": {
        "value": "$CONSUMPTION[1]$"
      },
      "fuse": {
        "alarm": "$FUSE_ALARM[1]$"
      }
    },
    {
      "name": "$PHASE_NAME[2]$",
      "number": "$PHASE_NUMBER[2]$",
      "voltage": {
        "value": "$VOLTAGE[2]$",
        "alarm": "$VOLTAGE_ALARM[2]$"
      },
      "current": {
        "value": "$CURRENT[2]$",
        "alarm": "$CURRENT_ALARM[2]$"
      },
      "power": {
        "active": {
          "value": "$POWER_ACTIVE[2]$",
          "alarm": "$POWER_ACTIVE_ALARM[2]$"
        },
        "reactive": {
          "value": "$POWER_REACTIVE[2]$",
          "alarm": "$POWER_REACTIVE_ALARM[2]$"
        },
        "apparent": {
          "value": "$POWER_APPARENT[2]$",
          "alarm": "$POWER_APPARENT_ALARM[2]$"
        },
        "factor": {
          "value": "$POWER_FACTOR[2]$"
        }
      },
      "frequency": {
        "value": "$FREQUENCY[2]$",
        "alarm": "$FREQUENCY_ALARM[2]$"
      },
      "consumption": {
        "value": "$CONSUMPTION[2]$"
      },
      "fuse": {
        "alarm": "$FUSE_ALARM[2]$"
      }
    },
    {
      "name": "$PHASE_NAME[3]$",
      "number": "$PHASE_NUMBER[3]$",
      "voltage": {
        "value": "$VOLTAGE[3]$",
        "alarm": "$VOLTAGE_ALARM[3]$"
      },
      "current": {
        "value": "$CURRENT[3]$",
        "alarm": "$CURRENT_ALARM[3]$"
      },
      "power": {
        "active": {
          "value": "$POWER_ACTIVE[3]$",
          "alarm": "$POWER_ACTIVE_ALARM[3]$"
        },
        "reactive": {
          "value": "$POWER_REACTIVE[3]$",
          "alarm": "$POWER_REACTIVE_ALARM[3]$"
        },
        "apparent": {
          "value": "$POWER_APPARENT[3]$",
          "alarm": "$POWER_APPARENT_ALARM[3]$"
        },
        "factor": {
          "value": "$POWER_FACTOR[3]$"
        }
      },
      "frequency": {
        "value": "$FREQUENCY[3]$",
        "alarm": "$FREQUENCY_ALARM[3]$"
      },
      "consumption": {
        "value": "$CONSUMPTION[3]$"
      },
      "fuse": {
        "alarm": "$FUSE_ALARM[3]$"
      }
    }
  ]
}

Available Variables​

Alarms​

Users​

Access​

Devices​

Sensors and Measurements​

Energy Monitoring​

Alarm Groups​

System​

Examples​

Simple Notification​

Access​

MultiSensor​

PowerManager​

Available Variables

Alarms

Users

Access

Devices

Sensors and Measurements

Energy Monitoring

Alarm Groups

System

Examples

Simple Notification

Access

MultiSensor

PowerManager