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
| Variable name | Description |
|---|---|
| Alarm | |
| “$ACTIVE_ALARM_SENSOR_NAME$” | Alarm Sensor Name |
| “$ACTIVE_ALARM_MEASUREMENT_VALUE$” | Alarm Sensor Measurement Value: (Value Unit) |
| “$ACTIVE_ALARM_VALUE$” | Alarm Sensor Alarm State: 0: OK 1: Alarm 2: Alarm acknowledgeable 3: Warning 4: Prealarm 5: Warning acknowledgeable |
| User | |
| “$USER_ID$” | User ID |
| “$USER_NAME$” | User Name |
| “$USER_FULLNAME$” | User Full Name |
| “$USER_MAIL$” | User Mail |
| “$USER_RFID_UID$” | User RFID UID |
| “$USER_RFID_DATA$” | User RFID DATA |
| “$USER_PIN$” | User PIN |
| “$USER_UUID$” | User UUID |
| “$USER_PHONE_NUMBER$” | User Phone number |
| Access | |
| “$ACCESS_STATE$” | Access Request Result: 0: Ok 1: Invalid remote request 2: Device not found 3: RFID unknown 4: PIN unknown 5: 2-factor auth. failed 6: User not found 7: No time permission 8: No door permission 9: General errror |
| Device | |
| “$DEVICE_ID$” | Device ID |
| “$DEVICE_NAME$” | Device Name |
| “$DEVICE_ADDRESS$ | Device Address |
| “$DEVICE_MAC$” | Device MAC |
| “$DEVICE_SERIAL$” | Device Serial Number |
| “$DEVICE_UUID$ | Device UUID |
| “$DEVICE_TYPE$” | Device Type |
| Sensors | |
| For all sensor variables: | “…_V ALUE ” =(Value Unit) |
| “…_A
LARM
” = Alarm Sensor Alarm State: 0: OK 1: Alarm 2: Alarm acknowledgeable 3: Warning 4: Prealarm 5: Warning acknowledgeable | |
| “...[number]$” = Number of Input: [ 1-9 ] | |
| “$INPUT_VALUE[number]$” | Input Measurement Value of Sensor |
| “$INPUT_ALARM[number]$” | Input Alarm State of Sensor |
| “$DI_NAME[number]$” | Digital Input Name |
| “$BATTERY_ALARM$” | Battery Alarm State |
| “$CO2_VALUE$” | CO2 Measurement Value |
| “$CO2_ALARM$” | CO2 Alarm State |
| “$DEWPOINT_VALUE$” | Dewpoint Measurement Value |
| “$DEWPOINT_ALARM$” | Dewpoint Alarm State |
| “$HUMIDITY_VALUE$” | Humidity Measurement Value |
| “$HUMIDITY_ALARM$” | Humidity Alarm State |
| “$LATENCY_VALUE$” | Latency Measurement Value |
| “$LATENCY_ALARM$” | Latency Alarm State |
| “$MOTION_VALUE$” | Motion Measurement Value |
| “$MOTION_ALARM$” | Motion Alarm State |
| “$REED_VALUE$” | Reed Measurement Value |
| “$REED_ALARM$” | Reed Alarm State |
| “$SABOTAGE_VALUE$” | Sabotage Measurement Value |
| “$SABOTAGE_ALARM$” | Sabotage Alarm State |
| “$CONNECTION_VALUE$” | Connection Measurement Value |
| “$CONNECTION_ALARM$” | Connection Alarm State |
| “$EXTPOWER_VALUE$” | External Power Measuremet Value |
| “$EXTPOWER_ALARM$” | External Power Alarm State |
| “$TEMPERATURE_VALUE$” | Temperature Measurement Value |
| “$TEMPERATURE_ALARM$” | Temperature Alarm State |
| “$TILT_VALUE$” | Tilt Measurement Value |
| “$TILT_ALARM$” | Tilt Alarm State |
| “$VIBRATION_VALUE$” | Vibration Measurement Value |
| “$VIBRATION_ALARM$” | Vibration Alarm State |
| “$SNMP_VALUE$” | SNMP Measurement Value |
| “$SNMP_ALARM$” | SNMP Alarm State |
| “$AIR_QUALITY_VALUE$” | Air Quality Measurement Value |
| “$AIR_QUALITY_ALARM$” | Air Quality Alarm State |
| “$AIR_QUALITY_FIRE_VALUE$” | Air Quality Fire Measurement Value |
| “$AIR_QUALITY_FIRE_ALARM$” | Air Quality Fire Alarm State |
| “$FIRE_HEAT_VALUE$” | Fire Heat Measurement Value |
| “$FIRE_HEAT_ALARM$” | Fire Heat Alarm State |
| “$FIRE_TI_VALUE$” | Fire TI Measurement Value |
| “$FIRE_TI_ALARM$” | Fire TI Alarm State |
| “$FIRE_CO_VALUE$ | Fire CO Measurement Value |
| “$FIRE_CO_ALARM$” | Fire CO Alarm State |
| Power | |
| For all power variables: | “…_V ALUE ” =(Value Unit) |
| “
…_
ALARM
” = Alarm State: 0: OK 1: Alarm 2: Alarm acknowledgeable 3: Warning 4: Prealarm 5: Warning acknowledgeable | |
| “…[number]$” = Number of Phase [ 1-3 ] | |
| phase | |
| “$PHASE_NAME[number]$” | Phase Name |
| “$PHASE_NUMBER[number]$” | Phase Number |
| “$VOLTAGE[number]$” | Phase Voltage |
| “$VOLTAGE_ALARM[number]$” | Phase Voltage Alarm State |
| “$CURRENT[number]$” | Phase Current |
| “$CURRENT_ALARM[number]$” | Phase Current Alarm State |
| “$POWER_ACTIVE[number]$” | Active Power |
| “$POWER_ACTIVE_ALARM[number]$” | Active Power Alarm State |
| “$POWER_REACTIVE[number]$” | Reactive Power |
| “$POWER_REACTIVE_ALARM[number]$” | Reactive Power Alarm State |
| “$POWER_APPARENT[number]$” | Apparent Power |
| “$POWER_APPARENT_ALARM[number]$” | Apparent Power Alarm State |
| “$POWER_FACTOR[number]$” | Power Factor |
| “$FREQUENCY[number]$” | Frequency |
| “$FREQUENCY_ALARM[number]$” | Frequency Alarm State |
| “$CONSUMPTION[number]$” | Power Consuption Value |
| “$FUSE_ALARM[number]$” | Fuse Alarm State |
| “$FUSE_VALUE[number]$” | Fuse Value |
| device | |
| “$RCM_AC$” | AC RCM |
| “$RCM_AC_ALARM$” | AC RCM Alarm State |
| “$RCM_DC$” | DC RCM |
| “$RCM_DC_ALARM$” | DC Alarm State |
| “$SYNCHRONICITY_VALUE$” | Power Synchronicity |
| “$SYNCHRONICITY_ALARM$” | Power Synchronicity Alarm State |
| Groups | |
| “$GROUP_ID$” | Group ID |
| “$GROUP_NAME$” | Group Name |
| “$GROUP_STATE$” | Group Arming State: 0: Disarmed 1: Armed |
“$GROUP_UUID$” | Group UUID |
| $GROUP_ARMED_PREALARM_COUNT$”” | Group “Armed Active” Prealarm Count |
| “$GROUP_ARMED_ALARM_COUNT$” | Group “Armed Active” Alarm Count |
| “$GROUP_ARMED_QUITABLE_ALARM_COUNT$” | Group “Armed Active” acknowledgeable alarms Count |
| “$GROUP_ARMED_WARNING_COUNT$” | Group “Armed Active” Warning Count |
| “$GROUP_ALWAYS_ALARM_COUNT$” | Group “Always Active” Alarm Count |
| “$GROUP_ALWAYS_QUITABLE_ALARM_COUNT$” | Group “Always Active” acknowledgeable alarm count |
| “$GROUP_ALWAYS_WARNING_COUNT$” | Group “Always Active” Warning Count |
| “$GROUP_ALWAYS_QUITABLE_WARNING_COUNT$” | Group “Always Active” acknowledgeable alarm count |
| “$GROUP_FIRE_ALARM_COUNT$” | Group “Fire” Alarm Count |
| “$GROUP_FIRE_QUITABLE_ALARM_COUNT$” | Group “Fire” acknowledgeable alarm count |
| “$GROUP_FIRE_WARNING_COUNT$” | Group “Fire” Warning Count |
| “$GROUP_FIRE_QUITABLE_WARNING_COUNT$” | Group “Fire” acknowledgeable Warning Count |
| “$GROUP_SABOTAGE_ALARM_COUNT$” | Group “Sabotage” Alarm Count |
| “$GROUP_SABOTAGE_QUITABLE_ALARM_COUNT$” | Group “Sabotage” acknowledgeable alarm count |
| “$GROUP_SABOTAGE_WARNING_COUNT$” | Group “Sabotage” Warning Count |
| “$GROUP_SABOTAGE_QUITABLE_WARNING_COUNT$” | Group “Sabotage” acknowledgeable Warning Count |
| “$GROUP_SYSTEM_ALARM_COUNT$” | Group “System” Alarm Count |
| “$GROUP_SYSTEM_QUITABLE_ALARM_COUNT$” | Group “System” acknowledgeable alarm count |
| “$GROUP_SYSTEM_WARNING_COUNT$” | Group “System” Warning Count |
| “$GROUP_SYSTEM_QUITABLE_WARNING_COUNT$” | Group “System” acknowledgeable Warning Count |
| System | |
| “$SYSTEM_TIME$” | System Time YYYY-MM-DD HH:MM:SS |
| “$SYSTEM_UNIXTIME$” | System Time in Unixtime (UTC) |
| “$SYSTEM_TEMP_UNIT$” | System Temperature Unit (F/C) |
| “$SYSTEM_NAME$” | System Name |
| “$SYSTEM_ADDRESS$” | System Address |
| “$SYSTEM_MAC$” | System MAC |
| “$SYSTEM_HOSTNAME$” | System hostname |
| “$SYSTEM_SERIAL$” | System Serial Number |
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]$"
}
}
]
}