1. Startseite
  2. KentixONE
  3. Benutzerhandbuch
  4. KONFIGURATION
  5. Webhooks
Auf der Suche nach...

Webhooks

Ein Webhook ist eine HTTP-basierte Rückmeldefunktion. Damit kann eine eventgesteuerte Kommunikation zwischen dem KentixONE System und einem externen Dienst aufgebaut werden. Unter diesem Menüpunkt werden Webhooks konfiguriert und verwaltet. Die erstellten Webhooks können anschließend einem Event zugeordnet werden. Die Zuordnung erfolgt in der Alarmgruppe oder in der Konfigurationsmaske eines Sensors.

Für die Konfiguration eines Webhooks werden die URL (Uniform Resource Locator) des externen Dienstes, mit dem das KentixONE System kommunizieren soll, die HTTP-Methode, der Inhaltstyp und die Daten des Webhooks benötigt. Die HTTP Methode entscheidet, ob Daten abgefragt, gesendet, verändert oder gelöscht werden sollen. Der Inhaltstyp klassifiziert die Daten des Webhooks und ermöglicht es dem externen Dienst, diese zu identifizieren. Nachstehend sind die Variablen und die entsprechenden Beispiele aufgeführt, die im Datenfeld verwendet werden können.

Die Verwaltung der Webhooks erfolgt in einer Tabellenansicht. In dieser Ansicht können auch bereits angelegte Webhooks bearbeitet und neue Webhooks angelegt werden.

Mögliche Variablen

Alarme

VariablennameBeschreibung
ACTIVEA​LARMS​ENSORN​AMEName
ACTIVEALARMMEASUREMENTVALUEMesswert
ACTIVEA​LARMA​LARMV​ALUEAlarmstatus
ACTIVEALARMSMSRECEIVEREmpfänger der Alarm-SMS
ALARMEVENTIDAPI-ID des zugehörigen Eintrags im Eventlogbuch

Mögliche Alarmstati sind
0: OK
1: Alarm
2: Alarm quittierbar
3: Warnung
4: Voralarmierung
5: Warnung quittierbar

Benutzer

VariablennameBeschreibung
USERIDID
USERNAMEName
USERFULLNAMEVollständiger Name
USERMAILE-Mailadresse
USERRFIDUIDRFID UID
USERRFIDDATARFID DATA
USERPINPIN
USERUUIDUUID
USERPHONENUMBERTelefonnummer

VariablennameBeschreibung
ACCESSSTATEBuchungsstatus
ACCESSEVENTIDAPI-ID des zugehörigen Eintrags im Zutrittslogbuch

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

VariablennameBeschreibung
DEVICEIDID
DEVICENAMEName
DEVICEADDRESSAdresse
DEVICEMACMAC-Adresse
DEVICESERIALSeriennummer
DEVICEUUIDUUID
DEVICETYPEGerätetyp

Sensoren und Messwerte

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

Mögliche Alarmstati sind
0: OK
1: Alarm
2: Alarm quittable
3: Warning
4: Prealarm
5: Warning quittable

VariablennameBeschreibung
INPUTVALUE[number]Messwert des Eingangs
INPUTALARM[number]Alarmstatus des Eingangs
DINAME[number]Name des digitalen Eingangs
BATTERYALARMBatterie Alarmstatus
BATTERYVALUEBatterie Messwert
BATTERYLEVELBatteriestandsstufe
BATTERYVOLTAGEBatterie Spannung
SIGNALLEVELFunksignal Empfangsstärkestufe
SIGNALSTRENGTHFunksignal Empfangsstärke dbM
CO2VALUECO2 Messwert
CO2ALARMCO2 Alarmstatus
DEWPOINTVALUETaupunkt Messwert
DEWPOINTALARMTaupunkt Alarmstatus
HUMIDITYVALUERel. Luftfeuchte Messwert
HUMIDITYALARMRel. Luftfeuchte Alarmstatus
LATENCYVALUELatenz Messwert
LATENCYALARMLatenz Alarmstatus
MOTIONVALUEBewegungserkennung Messwert
MOTIONALARMBewegungserkennung Alarmstatus
REEDVALUETürkontakt Messwert
REEDALARMTürkontakt Alarmstatus
SABOTAGEVALUESabotageerkennung Messwert
SABOTAGEALARMSabotageerkennung Alarmstatus
CONNECTIONVALUEVerbindungsstatus Messwert
CONNECTIONALARMVerbindungsstatus Alarmstatus
EXTPOWERVALUEExterne Stromversorgung Messwert
EXTPOWERALARMExterne Stromversorgung Alarmstatus
TEMPERATURE_VALUERaumtemperatur Messwert
TEMPERATURE_ALARMRaumtemperatur Alarmstatus
TILT_VALUEKippsensor Messwert
TILT_ALARMKippsensor Alarmstatus
VIBRATION_VALUEVibrationserkennung Messwert
VIBRATION_ALARMVibrationserkennung Alarmstatus
SNMP_VALUESNMP-Abfrage Messwert
SNMP_ALARMSNMP-Abfrage Messwert
AIR_QUALITY_VALUELuftqualität (Umgebungsmonitoring) Messwert
AIR_QUALITY_ALARMLuftqualität (Umgebungsmonitoring) Alarmstatus
AIR_QUALITY_FIRE_VALUELuftqualität (Brandfrüherkennung) Messwert
AIR_QUALITY_FIRE_ALARMLuftqualität (Brandfrüherkennung) Alarmstatus
FIRE_HEAT_VALUEHitzesensor Messwert
FIRE_HEAT_ALARMHitzesensor Alarmstatus
FIRE_TI_VALUEIR-Temperatur Messwert
FIRE_TI_ALARMIR-Temperatur Alarmstatus
FIRE_CO_VALUECO Messwert
FIRE_CO_ALARMCO Alarmstatus

Energieüberwachung

Für alle Sensorvariablen gilt
„…_VALUE“ = Messwert
„…_ALARM“ = Alarmstatus
„…[number]“ = Nummer/Index einer Phase. Die eckigen Klammern [ ] dürfen nicht mit angegeben werden

Mögliche Alarmstati sind
0: OK
1: Alarm
2: Alarm quittable
3: Warning
4: Prealarm
5: Warning quittable

VariablennameBeschreibung
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_ACAC-RCM Messwert
RCM_AC_ALARMAC-RCM Alarmstatus
RCM_DCDC-RCM Messwert
RCM_DC_ALARM$DC-RCM Alarmstatus
SYNCHRONICITY_VALUESynchronität Messwert
SYNCHRONICITY_ALARMSynchronität Alarmstatus

Alarmgruppen

VariablennameBeschreibung
GROUP_IDID
GROUP_NAMEName
GROUP_STATESchaltstatus (0=Unscharf, 1=Scharf)
GROUP_UUIDUUID
GROUP_ARMED_PREALARM_COUNTAnzahl der scharf-aktiven Voralarmierungen
GROUP_ARMED_ALARM_COUNTAnzahl der anstehenden scharf-aktiven Alarme
GROUP_ARMED_QUITABLE_ALARM_COUNTAnzahl der quittierbaren scharf-aktiven Alarme
GROUP_ARMED_WARNING_COUNTAnzahl der anstehenden scharf-aktiven Warnungen
GROUP_ARMED_QUITABLE_WARNING_COUNTAnzahl der quittierbaren scharf-aktiven Warnungen
GROUP_ALWAYS_ALARM_COUNTAnzahl der anstehenden dauer-aktiven Alarme
GROUP_ALWAYS_QUITABLE_ALARM_COUNTAnzahl der quittierbaren dauer-aktiven Alarme
GROUP_ALWAYS_WARNING_COUNTAnzahl der anstehenden dauer-aktiven Warnungen
GROUP_ALWAYS_QUITABLE_WARNING_COUNTAnzahl der quittierbaren dauer-aktiven Warnungen
GROUP_FIRE_ALARM_COUNTAnzahl der anstehenden Brand-Alarme
GROUP_FIRE_QUITABLE_ALARM_COUNTAnzahl der quittierbaren Brand-Alarme
GROUP_FIRE_WARNING_COUNTAnzahl der anstehenden Brand-Warnungen
GROUP_FIRE_QUITABLE_WARNING_COUNTAnzahl der quittierbaren Brand-Warnungen
GROUP_SABOTAGE_ALARM_COUNTAnzahl der anstehenden Sabotage-Alarme
GROUP_SABOTAGE_QUITABLE_ALARM_COUNTAnzahl der quittierbaren Sabotage-Alarme
GROUP_SABOTAGE_WARNING_COUNTAnzahl der anstehenden Sabotage-Warnungen
GROUP_SABOTAGE_QUITABLE_WARNING_COUNTAnzahl der quittierbaren Sabotage-Warnungen
GROUP_SYSTEM_ALARM_COUNTAnzahl der anstehenden Systemmeldungs-Alarmen
GROUP_SYSTEM_QUITABLE_ALARM_COUNTAnzahl der quittierbaren Systemmeldungs-Alarmen
GROUP_SYSTEM_WARNING_COUNTAnzahl der anstehenden Systemmeldungs-Warnungen
GROUP_SYSTEM_QUITABLE_WARNING_COUNTAnzahl der quittierbaren Systemmeldungs-Warnungen

System

VariablennameBeschreibung
SYSTEM_TIMESystemzeit im Format YYYY-MM-DD HH:MM:SS
SYSTEM_DATESystemzeit im Format YYYY-MM-DD
SYSTEM_UNIXTIMESystemzeit als UNIX-Zeitstempel (UTC)
SYSTEM_TEMP_UNITTemperatureinheit (C/F)
SYSTEM_NAMESystemname
SYSTEM_ADDRESSAdresse des Systems
SYSTEM_MACMAC-Adresse des Systems
SYSTEM_HOSTNAMEHostname des Systems
SYSTEM_SERIALSeriennummer 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]$"
      }
    }
  ]
}

Verwandte Artikel