Webhooks

Webhooks sind HTTP-basierte Callback-Mechanismen, die eine eventgesteuerte Kommunikation zwischen dem KentixONE System und externen Diensten ermöglichen. Sie werden in diesem Menübereich konfiguriert und verwaltet.

Zur Implementierung eines Webhooks sind folgende Parameter erforderlich:

URL (Uniform Resource Locator) des externen Dienstes als Kommunikationsendpunkt
HTTP-Methode für die Art der Interaktion (Abfrage, Senden, Ändern oder Löschen von Daten)
Content-Type zur Klassifizierung des Datenformats für den externen Dienst
Die zu übermittelnden Daten des Webhooks

Die konfigurierten Webhooks können anschließend als Event-Handler in Alarmgruppen oder Sensor-Konfigurationen eingebunden werden. Die Verwaltung erfolgt übersichtlich in einer tabellarischen Darstellung, die das Anlegen neuer sowie das Bearbeiten bestehender Webhooks ermöglicht.

Mögliche Variablen

Alarme

Variablenname	Beschreibung
$ACTIVE_ALARM_SENSOR_NAME$	Name
$ACTIVE_ALARM_MEASUREMENT_VALUE$	Messwert
$ACTIVE_ALARM_ALARM_VALUE$	Alarmstatus
$ACTIVE_ALARM_SMS_RECEIVER$	Empfänger der Alarm-SMS

$ALARM_EVENT_ID$	API-ID des zugehörigen Eintrags im Eventlogbuch

info

Mögliche Alarmstati sind

0: OK
1: Alarm
2: Alarm quittierbar
3: Warnung
4: Voralarmierung
5: Warnung quittierbar

Benutzer

Variablenname	Beschreibung
$USER_ID$	ID
$USER_NAME$	Name
$USER_FULLNAME$	Vollständiger Name
$USER_MAIL$	E-Mailadresse
$USER_RFID_UID$	RFID UID
$USER_RFID_DATA$	RFID DATA
$USER_PIN$	PIN
$USER_UUID$	UUID
$USER_PHONE_NUMBER$	Telefonnummer

Zutritt

Variablenname	Beschreibung
$ACCESS_STATE$	Buchungsstatus
$ACCESS_EVENT_ID$	API-ID des zugehörigen Eintrags im Zutrittslogbuch

hinweis

Mögliche Buchungsstati sind

0: Ok
1: Anfrage zum Fernöffnen ist ungültig
2: Gerät existiert nicht
3: Unbekannte RFID
4: Unbekannte PIN
5: Zwei-Faktor-Authentifizierung fehlgeschlagen
6: unbekannter Benutzer
7: Buchung außerhalb des erlaubten Zeitprofils
8: Keine Türberechtigung
9: Allgemeiner Fehler

Geräte

Variablenname	Beschreibung
$DEVICE_ID$	ID
$DEVICE_NAME$	Name
$DEVICE_ADDRESS$	Adresse
$DEVICE_MAC$	MAC-Adresse
$DEVICE_SERIAL$	Seriennummer
$DEVICE_UUID$	UUID
$DEVICE_TYPE$	Gerätetyp

Sensoren und Messwerte

info

Für alle Sensorvariablen gilt

"..._VALUE" = Messwert
"..._ALARM" = Alarmstatus
"...[number]" = Nummer/Index des digitalen oder analogen Eingangs. Die eckigen Klammern [ ] dürfen nicht mit angegeben werden

hinweis

Mögliche Alarmstati sind

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

Variablenname	Beschreibung
$INPUT_VALUE[number]$	Messwert des Eingangs
$INPUT_ALARM[number]$	Alarmstatus des Eingangs
$DI_NAME[number]$	Name des digitalen Eingangs

$BATTERY_ALARM$	Batterie Alarmstatus
$BATTERY_VALUE$	Batterie Messwert
$BATTERY_LEVEL$	Batteriestandsstufe
$BATTERY_VOLTAGE$	Batterie Spannung

$SIGNAL_LEVEL$	Funksignal Empfangsstärkestufe
$SIGNAL_STRENGTH$	Funksignal Empfangsstärke dbM

$CO2_VALUE$	CO2 Messwert
$CO2_ALARM$	CO2 Alarmstatus

$DEWPOINT_VALUE$	Taupunkt Messwert
$DEWPOINT_ALARM$	Taupunkt Alarmstatus

$HUMIDITY_VALUE$	Rel. Luftfeuchte Messwert
$HUMIDITY_ALARM$	Rel. Luftfeuchte Alarmstatus

$LATENCY_VALUE$	Latenz Messwert
$LATENCY_ALARM$	Latenz Alarmstatus

$MOTION_VALUE$	Bewegungserkennung Messwert
$MOTION_ALARM$	Bewegungserkennung Alarmstatus

$REED_VALUE$	Türkontakt Messwert
$REED_ALARM$	Türkontakt Alarmstatus

$SABOTAGE_VALUE$	Sabotageerkennung Messwert
$SABOTAGE_ALARM$	Sabotageerkennung Alarmstatus

$CONNECTION_VALUE$	Verbindungsstatus Messwert
$CONNECTION_ALARM$	Verbindungsstatus Alarmstatus

$EXTPOWER_VALUE$	Externe Stromversorgung Messwert
$EXTPOWER_ALARM$	Externe Stromversorgung Alarmstatus

$TEMPERATURE_VALUE$	Raumtemperatur Messwert
$TEMPERATURE_ALARM$	Raumtemperatur Alarmstatus

$TILT_VALUE$	Kippsensor Messwert
$TILT_ALARM$	Kippsensor Alarmstatus

$VIBRATION_VALUE$	Vibrationserkennung Messwert
$VIBRATION_ALARM$	Vibrationserkennung Alarmstatus

$SNMP_VALUE$	SNMP-Abfrage Messwert
$SNMP_ALARM$	SNMP-Abfrage Messwert

$AIR_QUALITY_VALUE$	Luftqualität (Umgebungsmonitoring) Messwert
$AIR_QUALITY_ALARM$	Luftqualität (Umgebungsmonitoring) Alarmstatus

$AIR_QUALITY_FIRE_VALUE$	Luftqualität (Brandfrüherkennung) Messwert
$AIR_QUALITY_FIRE_ALARM$	Luftqualität (Brandfrüherkennung) Alarmstatus

$FIRE_HEAT_VALUE$	Hitzesensor Messwert
$FIRE_HEAT_ALARM$	Hitzesensor Alarmstatus

$FIRE_TI_VALUE$	IR-Temperatur Messwert
$FIRE_TI_ALARM$	IR-Temperatur Alarmstatus

$FIRE_CO_VALUE$	CO Messwert
$FIRE_CO_ALARM$	CO Alarmstatus

Energieüberwachung

info

Für alle Sensorvariablen gilt

"..._VALUE" = Messwert
"..._ALARM" = Alarmstatus
"...[number]" = Nummer/Index einer Phase. Die eckigen Klammern [ ] dürfen nicht mit angegeben werden

hinweis

Mögliche Alarmstati sind

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

Variablenname	Beschreibung
$PHASE_NAME[number]$	Phasenname
$PHASE_NUMBER[number]$	Nummer der Phase

$VOLTAGE[number]$	Spannung Messwert
$VOLTAGE_ALARM[number]$	Spannung Alarmstatus

$CURRENT[number]$	Strom Messwert
$CURRENT_ALARM[number]$	Strom Alarmstatus

$POWER_ACTIVE[number]$	Wirkleistung Messwert
$POWER_ACTIVE_ALARM[number]$	Wirkleistung Alarmstatus

$POWER_REACTIVE[number]$	Blindleistung Messwert
$POWER_REACTIVE_ALARM[number]$	Blindleistung Alarmstatus

$POWER_APPARENT[number]$	Scheinleistung Messwert
$POWER_APPARENT_ALARM[number]$	Scheinleistung Alarmstatus

$POWER_FACTOR[number]$	Leistungsfaktor Messwert

$FREQUENCY[number]$	Frequenz Messwert
$FREQUENCY_ALARM[number]$	Frequenz Alarmstatus

$CONSUMPTION[number]$	Verbrauch Messwert

$FUSE_VALUE[number]$	Sicherung Messwert
$FUSE_ALARM[number]$	Sicherung Alarmstatus

$RCM_AC$	AC-RCM Messwert
$RCM_AC_ALARM$	AC-RCM Alarmstatus

$RCM_DC$	DC-RCM Messwert
RCM_DC_ALARM$	DC-RCM Alarmstatus

$SYNCHRONICITY_VALUE$	Synchronität Messwert
$SYNCHRONICITY_ALARM$	Synchronität Alarmstatus

Alarmgruppen

Variablenname	Beschreibung
$GROUP_ID$	ID
$GROUP_NAME$	Name
$GROUP_STATE$	Schaltstatus (0=Unscharf, 1=Scharf)
$GROUP_UUID$	UUID
$GROUP_ARMED_PREALARM_COUNT$	Anzahl der scharf-aktiven Voralarmierungen
$GROUP_ARMED_ALARM_COUNT$	Anzahl der anstehenden scharf-aktiven Alarme
$GROUP_ARMED_QUITABLE_ALARM_COUNT$	Anzahl der quittierbaren scharf-aktiven Alarme
$GROUP_ARMED_WARNING_COUNT$	Anzahl der anstehenden scharf-aktiven Warnungen
$GROUP_ARMED_QUITABLE_WARNING_COUNT$	Anzahl der quittierbaren scharf-aktiven Warnungen

$GROUP_ALWAYS_ALARM_COUNT$	Anzahl der anstehenden dauer-aktiven Alarme
$GROUP_ALWAYS_QUITABLE_ALARM_COUNT$	Anzahl der quittierbaren dauer-aktiven Alarme
$GROUP_ALWAYS_WARNING_COUNT$	Anzahl der anstehenden dauer-aktiven Warnungen
$GROUP_ALWAYS_QUITABLE_WARNING_COUNT$	Anzahl der quittierbaren dauer-aktiven Warnungen

$GROUP_FIRE_ALARM_COUNT$	Anzahl der anstehenden Brand-Alarme
$GROUP_FIRE_QUITABLE_ALARM_COUNT$	Anzahl der quittierbaren Brand-Alarme
$GROUP_FIRE_WARNING_COUNT$	Anzahl der anstehenden Brand-Warnungen
$GROUP_FIRE_QUITABLE_WARNING_COUNT$	Anzahl der quittierbaren Brand-Warnungen

$GROUP_SABOTAGE_ALARM_COUNT$	Anzahl der anstehenden Sabotage-Alarme
$GROUP_SABOTAGE_QUITABLE_ALARM_COUNT$	Anzahl der quittierbaren Sabotage-Alarme
$GROUP_SABOTAGE_WARNING_COUNT$	Anzahl der anstehenden Sabotage-Warnungen
$GROUP_SABOTAGE_QUITABLE_WARNING_COUNT$	Anzahl der quittierbaren Sabotage-Warnungen

$GROUP_SYSTEM_ALARM_COUNT$	Anzahl der anstehenden Systemmeldungs-Alarmen
$GROUP_SYSTEM_QUITABLE_ALARM_COUNT$	Anzahl der quittierbaren Systemmeldungs-Alarmen
$GROUP_SYSTEM_WARNING_COUNT$	Anzahl der anstehenden Systemmeldungs-Warnungen
$GROUP_SYSTEM_QUITABLE_WARNING_COUNT$	Anzahl der quittierbaren Systemmeldungs-Warnungen

System

Variablenname	Beschreibung
$SYSTEM_TIME$	Systemzeit im Format YYYY-MM-DD HH:MM:SS
$SYSTEM_DATE$	Systemzeit im Format YYYY-MM-DD
$SYSTEM_UNIXTIME$	Systemzeit als UNIX-Zeitstempel (UTC)
$SYSTEM_TEMP_UNIT$	Temperatureinheit (C/F)
$SYSTEM_NAME$	Systemname
$SYSTEM_ADDRESS$	Adresse des Systems
$SYSTEM_MAC$	MAC-Adresse des Systems
$SYSTEM_HOSTNAME$	Hostname des Systems
$SYSTEM_SERIAL$	Seriennummer des Systems

Beispiele

Einfache Meldung

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

Zutritt

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

Mögliche Variablen​

Alarme​

Benutzer​

Zutritt​

Geräte​

Sensoren und Messwerte​

Energieüberwachung​

Alarmgruppen​

System​

Beispiele​

Einfache Meldung​

Zutritt​

MultiSensor​

PowerManager​

Mögliche Variablen

Alarme

Benutzer

Zutritt

Geräte

Sensoren und Messwerte

Energieüberwachung

Alarmgruppen

System

Beispiele

Einfache Meldung

Zutritt

MultiSensor

PowerManager