Webhooks are HTTP triggers sent by an event. This event can be used to send data that makes it possible to control external APIs. The structure of the data can be specified as required. The changeable user data is added using variables. These are replaced at the time of triggering.

SmartXcan

Example

{
    "time": "$TIME$",
    "date": "$DATE$",

    "street": "$LOCATION_STREET$",
    "city": "$LOCATION_CITY$",
    "postal-code": "$LOCATION_POSTAL_CODE$",
    "country": "$LOCATION_COUNTRY$",

    "body-temperature-value": "$BODY_TEMPERATURE_VALUE$",
    "body-temperature-level": "$BODY_TEMPERATURE_LEVEL$",
    "body-temperature-alarm": "$BODY_TEMPERATURE_ALARM$",
    "outdoor-temperature": "$OUTDOOR_TEMPERATURE_VALUE$",
    "indoor-temperature": "$INDOOR_TEMPERATURE_VALUE$",
    "humidity": "$HUMIDITY_VALUE$",
    "sequence-number": "$SEQUENCE_NUMBER$",
	"event-id": "$EVENT_ID$",
	"RFID": "$RFIDUID$",

	"IP-address": "$IP$",
	"MAC-address": "$MAC$",
	"Serialnumber": "$SERIAL$"
}

Possible variables

AccessManager

Example

{
    "time": "$TIME$",
    "user": "$USERNAME$",
    "rfid": "$RFID$",
    "pin": "$PIN$",
    "state": "$STATE$",
    "door": "$DOORNAME$"
}

Possible variables

$USERID$ = ID of the user
$USERNAME$ = login name of the user
$USERFULLNAME$ = full name of the user
$USERMAIL$ = e-mail address of the user
$RFIDUID$ = RFID Uid of the card with which it was booked
$RFIDDATA$ = RFID data of the card with which was booked
$PIN$ = PIN entered
$TIME$ = time of the event as text string
$UNIXTIME$ = time of the event as UNIXTIME
$STATE$ = Status of booking (0: Access OK, 1: RFID unknown, 2: PIN unknown, 3: Double authentication failed, 4: Outside time profile, 5: No door authorization, 6: Authentication error)
$DOORID$ = Clamping unit ID
$DOORNAME$ = name of the door unit
$DOORSERIAL$ = Clamping unit serial number

PowerManager

Example

{
    "time": "$TIME$",
    "name": "$NAME$",
    "address": "$ADDRESS$",
    "rcm":
    {
        "ac":
        {
            "value": "$RCM_AC$",
            "alarm": "$RCM_AC_ALARM$"
        },
        "dc":
        {
            "value": "$RCM_DC$",
            "alarm": "$RCM_DC_ALARM$"
        }
    },
    "power_failure": "$POWER_FAILURE_ALARM$",
    "phases":
    [
        {
            "name": "$PHASE_NAME[1]$",
            "number": "$PHASE_NUMBER[1]$",
            "voltage":
            {
                "value": "$PHASE_VOLTAGE[1]$",
                "alarm": "$PHASE_VOLTAGE_ALARM[1]$"
            },
            "current":
            {
                "value": "$PHASE_CURRENT[1]$",
                "alarm": "$PHASE_CURRENT_ALARM[1]$"
            },
            "power":
            {
                "active":
                {
                    "value": "$PHASE_POWER_ACTIVE[1]$",
                    "alarm": "$PHASE_POWER_ACTIVE_ALARM[1]$"
                },
                "reactive":
                {
                    "value": "$PHASE_POWER_REACTIVE[1]$",
                    "alarm": "$PHASE_POWER_REACTIVE_ALARM[1]$"
                },
                "apparent":
                {
                    "value": "$PHASE_POWER_APPARENT[1]$",
                    "alarm": "$PHASE_POWER_APPARENT_ALARM[1]$"
                },
                "factor":
                {
                    "value": "$PHASE_POWER_FACTOR[1]$"
                }
            },
            "frequency":
            {
                "value": "$PHASE_FREQUENCY[1]$",
                "alarm": "$PHASE_FREQUENCY_ALARM[1]$"
            },
            "consumption":
            {
                "value": "$PHASE_CONSUMPTION[1]$"
            },
            "fuse":
            {
                "alarm": "$PHASE_FUSE_ALARM[1]$"
            }
        },
        {
            "name": "$PHASE_NAME[2]$",
            "number": "$PHASE_NUMBER[2]$",
            "voltage":
            {
                "value": "$PHASE_VOLTAGE[2]$",
                "alarm": "$PHASE_VOLTAGE_ALARM[2]$"
            },
            "current":
            {
                "value": "$PHASE_CURRENT[2]$",
                "alarm": "$PHASE_CURRENT_ALARM[2]$"
            },
            "power":
            {
                "active":
                {
                    "value": "$PHASE_POWER_ACTIVE[2]$",
                    "alarm": "$PHASE_POWER_ACTIVE_ALARM[2]$"
                },
                "reactive":
                {
                    "value": "$PHASE_POWER_REACTIVE[2]$",
                    "alarm": "$PHASE_POWER_REACTIVE_ALARM[2]$"
                },
                "apparent":
                {
                    "value": "$PHASE_POWER_APPARENT[2]$",
                    "alarm": "$PHASE_POWER_APPARENT_ALARM[2]$"
                },
                "factor":
                {
                    "value": "$PHASE_POWER_FACTOR[2]$"
                }
            },
            "frequency":
            {
                "value": "$PHASE_FREQUENCY[2]$",
                "alarm": "$PHASE_FREQUENCY_ALARM[2]$"
            },
            "consumption":
            {
                "value": "$PHASE_CONSUMPTION[2]$"
            },
            "fuse":
            {
                "alarm": "$PHASE_FUSE_ALARM[2]$"
            }
        },
        {
            "name": "$PHASE_NAME[3]$",
            "number": "$PHASE_NUMBER[3]$",
            "voltage":
            {
                "value": "$PHASE_VOLTAGE[3]$",
                "alarm": "$PHASE_VOLTAGE_ALARM[3]$"
            },
            "current":
            {
                "value": "$PHASE_CURRENT[3]$",
                "alarm": "$PHASE_CURRENT_ALARM[3]$"
            },
            "power":
            {
                "active":
                {
                    "value": "$PHASE_POWER_ACTIVE[3]$",
                    "alarm": "$PHASE_POWER_ACTIVE_ALARM[3]$"
                },
                "reactive":
                {
                    "value": "$PHASE_POWER_REACTIVE[3]$",
                    "alarm": "$PHASE_POWER_REACTIVE_ALARM[3]$"
                },
                "apparent":
                {
                    "value": "$PHASE_POWER_APPARENT[3]$",
                    "alarm": "$PHASE_POWER_APPARENT_ALARM[3]$"
                },
                "factor":
                {
                    "value": "$PHASE_POWER_FACTOR[3]$"
                }
            },
            "frequency":
            {
                "value": "$PHASE_FREQUENCY[3]$",
                "alarm": "$PHASE_FREQUENCY_ALARM[3]$"
            },
            "consumption":
            {
                "value": "$PHASE_CONSUMPTION[3]$"
            },
            "fuse":
            {
                "alarm": "$PHASE_FUSE_ALARM[3]$"
            }
        }
    ]
}

Possible variables

$TIME$ = time of the event as text string
$UNIXTIME$ = time of the event as UNIXTIME
$NAME$ = name of the smartmeter
$ADDRESS$ = address of the smartmeter
$RCM_AC$ = AC measured value of the differential current meter
$RCM_AC_ALARM$ = AC Alarm status of the residual current meter
$RCM_DC$ = DC measured value of the differential current meter
$RCM_DC_ALARM$ = DC Alarm status of the residual current meter
$POWER_FAILURE_ALARM$ = Power failure Smartmeter alarm 


Phase variables (these are indexed with [])
$PHASE_NAME[1]$ = Name of the phase
$PHASE_NUMBER[1]$ = Phase number
$PHASE_VOLTAGE[1]$ = Measured value of voltage
$PHASE_VOLTAGE_ALARM[1]$ = Alarm status of the voltage
$PHASE_CURRENT[1]$ = Measured value of the current strength
$PHASE_CURRENT_ALARM[1]$ = current alarm status
$PHASE_POWER_ACTIVE[1]$ = Active power measured value
$PHASE_POWER_ACTIVE_ALARM[1] = Active power alarm status
$PHASE_POWER_REACTIVE[1]$ = Measured value of reactive power
$PHASE_POWER_REACTIVE_ALARM[1] = Reactive power alarm status
$PHASE_POWER_APPARENT[1]$ = Measured value of apparent power
$PHASE_POWER_APPARENT_ALARM[1]$ = Apparent Power Alarm Status
$PHASE_POWER_FACTOR[1]$ = Power factor
$PHASE_FREQUENCY[1]$ = Measured value of frequency
$PHASE_FREQUENCY_ALARM[1]$ = Alarm status of the frequency
$PHASE_CONSUMPTION[1]$ = Current power consumption value
$PHASE_FUSE_ALARM[1]$ = Alarm status of a fuse


AlarmManager

Example

{
    "time": "$TIME$",
    "building": "$BUILDING_NAME$",
    "alarmzone": "$ALARMZONE_NAME$",
    "alarmzone-state": "$ALARMZONE_STATE$",
    "device": "$DEVICE_NAME$",
    "address": "$DEVICE_ADDRESS$",
    "temperature": "$TEMPERATURE_VALUE$",
    "temperature-alarm": "$TEMPERATURE_ALARM$",
    "humidity": "$HUMIDITY_VALUE$",
    "humidity-alarm": "$HUMIDITY_ALARM$",
    "dewpoint": "$DEWPOINT_VALUE$",
    "dewpoint-alarm": "$DEWPOINT_ALARM$",
    "fire": "$CO_VALUE$",
    "fire-alarm": "$CO_ALARM$",
    "intrusion": "$MOTION_VALUE$",
    "intrusion-alarm": "$MOTION_ALARM$",
    "vibration": "$VIBRATION_VALUE$",
    "vibration-alarm": "$VIBRATION_ALARM$",
    "input1": "$INPUT_VALUE[1]$",
    "input1-alarm": "$INPUT_ALARM[1]$",
    "input2": "$INPUT_VALUE[2]$",
    "input2-alarm": "$INPUT_ALARM[2]$",
    "connection": "$CONNECTION_VALUE$",
    "connection-alarm": "$CONNECTION_ALARM$",
    "extpower": "$EXTPOWER_VALUE$",
    "extpower-alarm": "$EXTPOWER_ALARM$"
}

Possible variables