Webhooks

A webhook is an HTTP-based feedback function. This allows event-controlled communication to be established between the KentixONE system and an external service. Webhooks are configured and managed under this menu item. The webhooks created can then be assigned to an event. The assignment is made in the alarm group or in the configuration mask of a sensor.

To configure a webhook, the URL (Uniform Resource Locator) of the external service with which the KentixONE system is to communicate, the HTTP method, the content type and the data of the webhook are required. The HTTP method decides whether data should be requested, sent, changed or deleted. The content type classifies the data of the webhook and enables the external service to identify it. The variables and the corresponding examples that can be used in the data field are listed below.

The webhooks are managed in a table view. In this view, webhooks that have already been created can also be edited and new webhooks can be created.

Possible variables

Alarms

Variable name	Description
_{ACTIVEALARMSORNAME}	Name
_{ACTIVEALARMMEASUREMENTVALUE}	Measured value
_{ACTIVEALARMALARMVALUE}	Alarm status
_{ACTIVEALARMSMSRECEIVER}	Recipient of the alarm SMS

_ALARMEVENTID	API ID of the corresponding entry in the event logbook

Possible alarm statuses are
0: OK
1: Alarm
2: Alarm can be acknowledged
3: Warning
4: Pre-alarm
5: Warning can be acknowledged

User

Variable name	Description
_USERID	ID
_USERNAME	Name
_USERFULLNAME	Full name
_USERMAIL	e-mail address
_USERRFIDUID	RFID UID
_USERRFIDDATA	RFID DATA
_USERPIN	PIN
_USERUUID	UUID
_{USERPHONENUMBER}	Phone number

Variable name	Description
_ACCESSSTATE	Booking status
_{ACCESSEVENTID}	API ID of the corresponding entry in the access logbook

Possible booking statuses are
0: Ok
1: Request for remote opening is invalid
2: Device does not exist
3: Unknown RFID
4: Unknown PIN
5: Two-factor authentication failed
6: Unknown user
7: Booking outside the permitted time profile
8: No door authorization
9: General error

Devices

Variable name	Description
_DEVICEID	ID
_DEVICENAME	Name
_{DEVICEADDRESS}	Address
_DEVICEMAC	MAC address
_DEVICESERIAL	Serial number
_DEVICEUUID	UUID
_DEVICETYPE	Device type

Sensors and measured values

The following applies to all sensor variables
“…_VALUE” = Measured value
“…_ALARM” = Alarm status
“…[number]” = Number/index of the digital or analog input. The square brackets [ ] must not be included

Possible alarm statuses are
0: OK
1: Alarm
2: Alarm quittable
3: Warning
4: Prealarm
5: Warning quittable

Variable name	Description
_INPUTVALUE[number]	Measured value of the input
_INPUTALARM[number]	Alarm status of the input
_DINAME[number]	Name of the digital input

BATTERY _ALARM	Battery alarm status
_BATTERYVALUE	Battery measured value
_BATTERYLEVEL	Battery level
_{BATTERYVOLTAGE}	Battery voltage

_SIGNALLEVEL	Radio signal Reception strength level
_{SIGNALSTRENGTH}	Radio signal reception strength dbM

_CO2VALUE	CO2 measured value
_CO2ALARM	CO2 alarm status

_{DEWPOINTVALUE}	Dew point measured value
_{DEWPOINTALARM}	Dew point alarm status

_{HUMIDITYVALUE}	Rel. Humidity measured value
_{HUMIDITYALARM}	Rel. Humidity alarm status

_LATENCYVALUE	Latency measured value
_LATENCYALARM	Latency alarm status

_MOTIONVALUE	Motion detection Measured value
_MOTIONALARM	Motion detection Alarm status

_REEDVALUE	Door contact Measured value
_REEDALARM	Door contact alarm status

_{SABOTAGEVALUE}	Sabotage detection Measured value
_{SABOTAGEALARM}	Tamper detection Alarm status

_{CONNECTIONVALUE}	Connection status Measured value
_{CONNECTIONALARM}	Connection status Alarm status

_{EXTPOWERVALUE}	External power supply Measured value
_{EXTPOWERALARM}	External power supply Alarm status

`TEMPERATURE_VALUE`	Room temperature Measured value
`TEMPERATURE_ALARM`	Room temperature alarm status

`TILT_VALUE`	Tilt sensor Measured value
`TILT_ALARM`	Tilt sensor alarm status

`VIBRATION_VALUE`	Vibration detection Measured value
`VIBRATION_ALARM`	Vibration detection Alarm status

`SNMP_VALUE`	SNMP query measured value
`SNMP_ALARM`	SNMP query measured value

`AIR_QUALITY_VALUE`	Air quality (ambient monitoring) Measured value
`AIR_QUALITY_ALARM`	Air quality (ambient monitoring) Alarm status

`AIR_QUALITY_FIRE_VALUE`	Air quality (early fire detection) Measured value
`AIR_QUALITY_FIRE_ALARM`	Air quality (early fire detection) Alarm status

`FIRE_HEAT_VALUE`	Heat sensor Measured value
`FIRE_HEAT_ALARM`	Heat sensor alarm status

`FIRE_TI_VALUE`	IR temperature Measured value
`FIRE_TI_ALARM`	IR temperature Alarm status

`FIRE_CO_VALUE`	CO measured value
`FIRE_CO_ALARM`	CO alarm status

Energy monitoring

The following applies to all sensor variables
“…_VALUE” = measured value
“…_ALARM” = alarm status
“…[number]” = number/index of a phase. The square brackets [ ] must not be included

Possible alarm statuses 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 measured value
`VOLTAGE_ALARM[number]`	Voltage Alarm status

`CURRENT[number]`	Current measured value
`CURRENT_ALARM[number]`	Current alarm status

`POWER_ACTIVE[number]`	Active power Measured value
`POWER_ACTIVE_ALARM[number]`	Active power Alarm status

`POWER_REACTIVE[number]`	Reactive power measured value
`POWER_REACTIVE_ALARM[number]`	Reactive power alarm status

`POWER_APPARENT[number]`	Apparent power Measured value
`POWER_APPARENT_ALARM[number]`	Apparent power Alarm status

`POWER_FACTOR[number]`	Power factor Measured value

`FREQUENCY[number]`	Frequency Measured value
`FREQUENCY_ALARM[number]`	Frequency Alarm status

`CONSUMPTION[number]`	Consumption measured value

`FUSE_VALUE[number]`	Fuse Measured value
`FUSE_ALARM[number]`	Alarm status fuse

`RCM_AC`	AC-RCM measured value
`RCM_AC_ALARM`	AC-RCM alarm status

`RCM_DC`	DC-RCM measured value
RCM_DC_ALARM$	DC-RCM alarm status

`SYNCHRONICITY_VALUE`	Synchronism Measured value
`SYNCHRONICITY_ALARM`	Synchronous alarm status

Alarm groups

Variable name	Description
`GROUP_ID`	ID
`GROUP_NAME`	Name
`GROUP_STATE`	Switching status (0=disarmed, 1=armed)
`GROUP_UUID`	UUID
`GROUP_ARMED_PREALARM_COUNT`	Number of active pre-alarms
`GROUP_ARMED_ALARM_COUNT`	Number of pending armed-active alarms
`GROUP_ARMED_QUITABLE_ALARM_COUNT`	Number of armed-active alarms that can be acknowledged
`GROUP_ARMED_WARNING_COUNT`	Number of pending active warnings
`GROUP_ARMED_QUITABLE_WARNING_COUNT`	Number of armed-active warnings that can be acknowledged

`GROUP_ALWAYS_ALARM_COUNT`	Number of pending permanently active alarms
`GROUP_ALWAYS_QUITABLE_ALARM_COUNT`	Number of permanently active alarms that can be acknowledged
`GROUP_ALWAYS_WARNING_COUNT`	Number of pending permanently active warnings
`GROUP_ALWAYS_QUITABLE_WARNING_COUNT`	Number of permanently active warnings that can be acknowledged

`GROUP_FIRE_ALARM_COUNT`	Number of pending fire alarms
`GROUP_FIRE_QUITABLE_ALARM_COUNT`	Number of fire alarms that can be acknowledged
`GROUP_FIRE_WARNING_COUNT`	Number of pending fire warnings
`GROUP_FIRE_QUITABLE_WARNING_COUNT`	Number of acknowledgeable fire alarms

`GROUP_SABOTAGE_ALARM_COUNT`	Number of pending sabotage alarms
`GROUP_SABOTAGE_QUITABLE_ALARM_COUNT`	Number of sabotage alarms that can be acknowledged
`GROUP_SABOTAGE_WARNING_COUNT`	Number of pending sabotage warnings
`GROUP_SABOTAGE_QUITABLE_WARNING_COUNT`	Number of sabotage warnings that can be acknowledged

`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 the format YYYY-MM-DD HH:MM:SS
`SYSTEM_DATE`	System time in the 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`	Address of the system
`SYSTEM_MAC`	MAC address of the system
`SYSTEM_HOSTNAME`	Host name of the system
`SYSTEM_SERIAL`	Serial number of the system

Examples

Simple message

{
  "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]$"
      }
    }
  ]
}