Forwarding to an HTTPS endpoint (Webhooks)
We forward messages to an HTTPS endpoint by issueing POST request to a destination of choice. The body of these requests are JSON encoded and contain a Content-Type: application/json header. Depending on the authentication there might be other headers present. The body is an array that can include messages of different types. We support authentication by means of inserting a token in the Authorization header, but the Client Credentials grant type is also supported.
Below, examples of the payloads of the following messages can be found:
Solar power
Solar assets produce two types of messages: regular messages and flash messages.
Regular messages
An example of a request containing one message forwarded from a Teleport device that is connected to a solar inverter:
[ { "type": "solarPower:2", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "huawei-4100", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt. integer "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "activePower": 12000.1, // in W, can be null "generatedEnergy": 250000.1, // in Wh, can be null "activePowerLimit": { "percentage": 30.1, // can be null "reduction": null // always null. deprecated but present to be non-breaking }, "availableActivePower": 20000.1, // in W, can be null. Always null if no pyranometer or irradiance sensor is installed "alarms": ["huawei_inverter_abnormal_string_power", "huawei_inverter_output_overcurrent"], // See solar alarms under error codes section. Empty if inverter-specific alarms are present in inverter array. "inverters": [ { "slaveId": 1, // identifies the individual inverter "activePower": 12000.4, // in W, can be null "generatedEnergy": 250000.7, // in Wh, can be null "activePowerLimit": { "percentage": 30.4 // can be null }, "alarms": ["huawei_inverter_abnormal_string_power", "huawei_inverter_output_overcurrent"] // See solar alarms under error codes section } // in case of multiple slave inverters that are read out, can be many ], "scheduled": true // false for "extra" measurements (eg. directly after command execution and at Teleport initialisation) }]Flash messages
Solar assets report flash messages more often than regular messages (typically every second) and contain information that is needed for dispatching algorithms and to forward to the TSO when doing aFRR. Flash messages are active only when the relevant control strategy is activated. An example of a request containing one flash message forwarded from a Teleport device that is connected to a solar asset.
[ { "type": "solarPower.flash:1", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "huawei-4100", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "activePower": 12000.8, // in W, can be null "availableActivePower": 20000.7, // in W, can be null. Always null if no pyranometer or irradiance sensor is installed "scheduled": true // false for "extra" measurements (eg. directly after command execution and at Teleport initialisation) }]Wind power
An example of a request containing one message forwarded from a Teleport device that is connected to a wind energy converter:
[ { "type": "windPower:2", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "enercon-4100", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt. integer "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "activePower": 12000.1, // in W, can be null "windSpeed": 2.1, // in m/s, can be null "availableActivePower": 12000.1, // in W, can be null "constrainedAvailableActivePower": { "currentWind": 12000.1, // in W, can be null "technical": 12000.1, // in W, can be null "forceMajeure": 12000.1, // in W, can be null "externalSetpoints": 12000.1 // in W, can be null }, "converters": [ { "identifier": "12345", // serial number of the converter "activePower": 3.6, // in W, can be null "windSpeed": 2.4, // in m/s, can be null "generatedEnergy": 230000, // in Wh, can be null "status": "on" // can be "running", "on", "pause", "stop". Missing if not available }, { "identifier": "6789", // serial number of the converter "activePower": 9.2, // in W, can be null "windSpeed": 2.4, // in m/s, can be null "generatedEnergy": 230000, // in Wh, can be null "status": "on" // can be "running", "on", "pause", "stop". Missing if not available } ], "activePowerLimit": { "percentage": 5.2 // can be null }, "generatedEnergy": 460000, // in Wh, can be null "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation }]Flash messages
Wind assets report flash messages more often than regular messages (typically every four seconds) and contain information that is needed for dispatching algorithms and to forward to the TSO when doing aFRR. Flash messages are active only when the relevant control strategy is activated. An example of a request containing one flash message forwarded from a Teleport device that is connected to a wind asset.
[ { "type": "windPower.flash:1", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "vestas-4100", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "activePower": 12000.8, // in W, can be null "availableActivePower": 20000.7, // in W, can be null. "scheduled": true // false for "extra" measurements (eg. directly after command execution and at Teleport initialisation) }]Battery power
Batteries produce two types of messages: regular messages and flash messages. Regular messages can be exported in full, or to contain only information relevant for operators. For the strings that can occur in the errors and warnings properties, see Battery power error and warning codes.
Regular messages in full
An example of a request containing one message forwarded from a Teleport device that is connected to a battery:
[ { "type": "batteryPower:1", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "alfen-123", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt. integer "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "batteryStatus": "on", // can be "on", "off", "other" or null (see warning and errors in case of 'other') "energy": { "charged": 1000.2, // in Wh, can be null. Nonnegative "discharged": 1000.3 // in Wh, can be null. Nonnegative }, "frequency": 50.2, // in Hz, can be null. Nonnegative "activePower": 1000.1, // in W, can be null. Positive means discharging, negative charging. "reactivePower": 100.1, // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power "stateOfCharge": 90.1, // in %, can be null. Nonnegative "stateOfHealth": 85.1, // in %, can be null. Nonnegative "availableEnergy": 50.1, // in Wh, can be null. Nonnegative "ratedEnergy": 1000.1, // in Wh, can be null. Nonnegative "availableActivePower": { "charge": 300.1, // in W, can be null. Nonnegative "discharge": 500.1 // in W, can be null. Nonnegative }, "availableReactivePower": { "inject": 300.1, // in var, can be null. Nonnegative "absorb": 500.1 // in var, can be null. Nonnegative }, "activePowerSetpoint": { "dispatchPower": 100.1, // in W, can be null. Positive means discharging, negative charging. "deliverFCR": 100.1, // in W, can be null. Positive means discharging, negative charging. "chargeToState": 20.1, // in W, can be null. Positive means discharging, negative charging. "aggregate": 220.1 // in W, can be null. Positive means discharging, negative charging. }, "threePhaseConnectionTypeHighVoltage": "delta", // can be "wye" or "delta", can be null "acVoltageMediumVoltage": { "phase": { "l1": 230.4, // in V, can be null. Nonnegative "l2": 230.1, // in V, can be null. Nonnegative "l3": 230.2 // in V, can be null. Nonnegative }, // can be null "line": { "l1": 230.4, // in V, can be null. Nonnegative "l2": 230.1, // in V, can be null. Nonnegative "l3": 230.2 // in V, can be null. Nonnegative } // can be null }, "acCurrentMediumVoltage": { "phase": { "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value }, // can be null "line": { "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value } // can be null }, "auxiliaryPower": { "active": -120.3, // in W, can be null. Negative means consuming, positive generating, will be negative or 0 "reactive": -28.4 // in Var, can be null. Negative means consuming, positive generating, will be negative or 0 }, // can be null "batteryEnergyStorageSystems": [ { "identifier": "alfen-5678", // brand and serial number of the bess or if that's not available, its index "cellTemperature": { "min": 50.1, // in ºC, can be null, min value of all cells "max": 50.1 // in ºC, can be null, max value of all cells }, "roomTemperature": 30.1, // in ºC, can be null "stateOfCharge": 50.1, // in %, can be null. Nonnegative "availableEnergy": 1000.1, // in Wh, can be null. Nonnegative "availableActivePower": { "charge": 300.1, // in W, can be null. Nonnegative "discharge": 500.1 // in W, can be null. Nonnegative }, "threePhaseConnectionTypeLowVoltage": "wye", // can be "wye" or "delta", can be null "acVoltageLowVoltage": { "phase": { "l1": 230.4, // in V, can be null. Nonnegative "l2": 230.1, // in V, can be null. Nonnegative "l3": 230.2 // in V, can be null. Nonnegative }, // can be null "line": { "l1": 230.4, // in V, can be null. Nonnegative "l2": 230.1, // in V, can be null. Nonnegative "l3": 230.2 // in V, can be null. Nonnegative } // can be null }, "acCurrentLowVoltage": { "phase": { "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value }, // can be null "line": { "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value } // can be null }, "racks": [ { "identifier": "alfen-1", // brand and serial number of the rack or if that's not available, its index "dcVoltage": 12.5, // in V, can be null. Nonnegative "dcCurrent": 23.5 // in A, can be null. Delivering to the grid is a positive value } // can be many ], "warnings": ["ALFEN_SOME_WARNING_1", "ATEPS_SOME_WARNING_2"], // see error codes section "errors": ["ALFEN_SOME_ERROR_1"] // see error codes section } // can be many ], // The configuration property has the same structure as the operation property of a SetBatteryOperation. Values are actually read out from the battery, not just a copy of what the Teleport has been instructed to do "configuration": { // When dispatchPower is null but the battery system does not support stand-by mode, the Teleport will send a schedule with 0 W to the asset, while the reported dispatchPower is null. "dispatchPower": { "activePower": 50.1 // In W, Positive means discharging, negative charging. }, // can be null "deliverFCR": { "maxRate": 100.1 // In W, Nonnegative. }, // can be null "chargeToState": { "percentage": 50.1 // In %, Nonnegative. } // can be null }, // can be null "warnings": ["ALFEN_SOME_WARNING_1", "ATEPS_SOME_WARNING_B"], // see error codes section "errors": ["ALFEN_SOME_ERROR_1"], // see error codes section "scheduleCompleteUntil": "2023-01-01T00:00:00Z", // first gap in the schedule for this assetIdentifier. ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC, can be null "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation }]Regular messages for operators
A regular message for operators contains a subset of the information available in the regular message and is sent out at the same frequency. An example of a request containing one message for operators forwarded from a Teleport device that is connected to a battery:
[ { "type": "batteryPower.filtered:1", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "alfen-123", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt. integer "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "batteryStatus": "on", // can be "on", "off", "other" or null (see warning and errors in case of 'other') "frequency": 50.1, // in Hz, can be null. Nonnegative "activePower": 1000.1, // in W, can be null. Positive means discharging, negative charging. "stateOfCharge": 90.1, // in %, can be null. Nonnegative "availableEnergy": 50.1, // in Wh, can be null. Nonnegative "ratedEnergy": 1000.1, // in Wh, can be null. Nonnegative "availableActivePower": { "charge": 300.1, // in W, can be null. Nonnegative "discharge": 500.1 // in W, can be null. Nonnegative }, "batteryEnergyStorageSystems": [ { "identifier": "alfen-5678", // brand and serial number of the bess or if that's not available, its index "cellTemperature": { "min": 50.1, // in ºC, can be null, min value of all cells "max": 50.1 // in ºC, can be null, max value of all cells } } // can be many ], // The configuration property has the same structure as the operation property of a SetBatteryOperation. Values are actually read out from the battery, not just a copy of what the Teleport has been instructed to do "configuration": { "dispatchPower": { "activePower": 50.1 // In W, Positive means discharging, negative charging. }, // can be null "deliverFCR": { "maxRate": 100.1 // In W, Nonnegative. }, // can be null "chargeToState": { "percentage": 50.1 // In %, Nonnegative. } // can be null }, // can be null "warnings": ["ALFEN_SOME_WARNING_1", "ATEPS_SOME_WARNING_B"], // see error codes section "errors": ["ALFEN_SOME_ERROR_1"], // see error codes section "scheduleCompleteUntil": "2023-01-01T00:00:00Z", // first gap in the schedule for this assetIdentifier. ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC, can be null "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation }]Flash messages
Batteries report flash messages more often than regular messages (typically every second) and contain information that is needed for dispatching algorithms and to forward to the TSO when doing aFRR/FCR. An example of a request containing one flash message forwarded from a Teleport device that is connected to a battery:
[ { "type": "batteryPower.flash:1", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "alfen-123", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt. integer "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "frequency": 50.1, // in Hz, can be null "activePower": 1000.1, // in W, can be null. Positive means discharging, negative charging. "availableEnergy": 1000.1, // in Wh, can be null "availableActivePower": { "charge": 300.1, // in W, can be null "discharge": 500.1 // in W, can be null }, "stateOfCharge": 90.1, // in %, can be null. "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation }]EV power
An example of a request containing one message forwarded from a Teleport device that is connected to a (set of) EV charger stations. For the strings that can occur in the errors and warnings properties, see Battery power error and warning codes.
[ { "type": "evPower:1", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "phoenix-contact-charx-abd9234", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt. integer "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "currentType": "ac", // can be "ac" or "dc" or "mixed" "power": -40700.23, // in W, can be null. Negative if charging a vehicle (consuming from the grid). Active power in case currentType is "ac" "energyConsumed": 93702.1, // in Wh, can be null. Nonnegative. Active consumed energy in case currentType is "ac" "energyProduced": null, // in Wh, can be null. Nonnegative. Active produced energy in case currentType is "ac". Only relevant for bidirectional chargers "errors": [], // array of strings. see error codes section "limit": { // can be null, the setpoints reported by the EV charging point "current": -16; // in A, can be null. The actual current limit, combining setpoints from the Teleport with that of other sources (eg. the vehicles over OCPP) "power": null; // in W, can be null. The actual power limit, combining setpoints from the Teleport with that of other sources (eg. the vehicles over OCPP) }, "configuration": { "limit": { // the setpoints written by the Teleport in the EV charging point "current": -30, // in A, can be null. Negative if charging a vehicle (consuming from the grid) "power": null // in W, can be null. Negative if charging a vehicle (consuming from the grid). Active power in case currentType is "ac". For EV chargers that only allow control via current this property is null. In that case the Teleport converts the setpoint to a current value and it is included there. } }, "stations": [ { "identifier": "x9844a", // not guaranteed to be unique outside the asset "errors": [], // array of strings. see error codes section "points": [ { "identifier": "ge874564", // not guaranteed to be unique outside the station "currentType": "ac-3-phase-wye", // can be "ac-3-phase-wye", "ac-3-phase-delta", "ac-1-phase" and "dc" "errors": ["phoenix_contact_charx_external_temperature_too_high"], // array of strings. see error codes section "isCharging": true, // can be null "vehicleConnected": true, // can be null "limit": { // can be null, the setpoints reported by the EV charging point "current": -16; // in A, can be null. The actual current limit, combining setpoints from the Teleport with that of other sources (eg. the vehicles over OCPP) "power": null; // in W, can be null. The actual power limit, combining setpoints from the Teleport with that of other sources (eg. the vehicles over OCPP) }, "configuration": { "limit": { // the setpoints written by the Teleport in the EV charging point "current": -15, // in A, can be null. Negative if charging a vehicle (consuming from the grid) "power": null // in W, can be null. Negative if charging a vehicle (consuming from the grid). Active power in case currentType is "ac". For EV chargers that only allow control via current this property is null. In that case the Teleport converts the setpoint to a current value and it is included there. } }, "voltage": { // can be null, phase voltage for currentType "ac-3-phase-wye". Is a number or null for "dc" and "ac-1-phase" currentTypes "l1": 230.4, // in V, can be null. Nonnegative "l2": 230.1, // in V, can be null. Nonnegative "l3": 230.2 // in V, can be null. Nonnegative }, "current": { // can be null, phase current for currentType "ac-3-phase-delta". Is a number or null for "dc" and "ac-1-phase" currentTypes "l1": -14.9, // in A, can be null. Charging a vehicle has a negative value "l2": -15.0, // in A, can be null. Charging a vehicle has a negative value "l3": -15.1 // in A, can be null. Charging a vehicle has a negative value }, "energyConsumed": 33702.1, // in Wh, can be null. is active energy for AC currentTypes "energyProduced": 254.9, // in Wh, can be null. is active energy for AC currentTypes. Only relevant for bidirectional chargers "power": { // can be null, is active power for AC currentTypes. Is a number or null for "dc" and "ac-1-phase" currentTypes "l1": -3410.01, // in W, can be null. Charging a vehicle has a negative value "l2": -3400.01, // in W, can be null. Charging a vehicle has a negative value "l3": -3440.01, // in W, can be null. Charging a vehicle has a negative value "sum": -10250.03 // in W, can be null. Charging a vehicle has a negative value } }, ... ] } ], "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation }]Meter power
An example of a request containing one message forwarded from a Teleport device that is connected to a power meter:
[ { "type": "meterPower:1", // identifies this schema "teleportHashId": "8de4y2", // uniquely identifies the teleport device "assetIdentifier": "janitza-UMG806-12345", // globally unique identifier of the asset, when available the brand and serial number of the asset "attempt": 0, // 0-indexed delivery attempt. integer "measuredAt": "2023-01-01T00:00:00Z", // when read-out started, ISO 8601 yyyy-mm-ddThh:mm:ssZ or YYYYYY-MM-DDTHH:mm:ss.sssZ, so in UTC "phaseVoltage": { "l1": 230.4, // in V, can be null. Nonnegative "l2": 230.1, // in V, can be null. Nonnegative "l3": 230.2 // in V, can be null. Nonnegative }, "current": { "l1": 11.4, // in A, can be null. Delivering to the grid is a positive value "l2": 12.5, // in A, can be null. Delivering to the grid is a positive value "l3": 10.1 // in A, can be null. Delivering to the grid is a positive value }, "activePower": { "l1": 2626.56, // in W, can be null. Delivering to the grid is a positive value "l2": 2876.25, // in W, can be null. Delivering to the grid is a positive value "l3": 2325.02, // in W, can be null. Delivering to the grid is a positive value "sum": 7827.83 // in W, can be null. Delivering to the grid is a positive value }, "reactivePower": { "l1": 0.2, // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power "l2": 0.2, // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power "l3": 0.2, // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power "sum": 0.2 // in var, can be null. Positive is injecting reactive power to the grid and negative is absorbing reactive power }, "frequency": 50.21, // in Hz, can be null. Nonnegative "activeEnergyConsumed": { "l1": 31235.1, // in Wh, can be null. Nonnegative "l2": 31235.1, // in Wh, can be null. Nonnegative "l3": 31235.1, // in Wh, can be null. Nonnegative "sum": 93702.1 // in Wh, can be null. Nonnegative }, "activeEnergyDelivered": { "l1": 31235.2, // in Wh, can be null. Nonnegative "l2": 31235.2, // in Wh, can be null. Nonnegative "l3": 31235.2, // in Wh, can be null. Nonnegative "sum": 93702.2 // in Wh, can be null. Nonnegative }, "scheduled": true // false for measurements that are not part of the regular reporting interval, eg. directly after command execution and at Teleport initialisation }]