Skip to main content

Event Types

domain_model

Connectivity Status​

Notifications about an appliance coming online / offline.

The connectivity status is checked every 15 minutes, so the status change will be sent to the partner within this time.

Appliance Status​

Notifications about errors and warnings that occur for an appliance.

Whether an appliance status event leads to a notification is decided based on rules, the two main ones being defined by the number of times an event occurs and the delay between event occurrences.

One example for events that are not sent to a subscribed client are transient errors.

Contract Status​

Notifications about changes in a contract.

A change on the contract status will trigger a notification to be sent to the partner with properties that allow to identify the contract transition that has occurred.

The possible contract transitions are described in the Contract Status Flow section.

Data Point​

Notifications about data points measured for the appliance:

  • The frequency with which each data point is updated as well as the resolution of the value that is provided depends on the data point itself, the gateway type and the firmware. Not every data point change is pushed as an event in order to avoid flooding the partner's webhook with events. Instead, for each data point a change threshold has been defined.

  • Data point events will only be pushed to the webhook in case the value changed.

  • If a new gateway is paired and the required access is granted (see below), it can take up to 5 minutes before data point event notifications are received. If a gateway is unpaired, data point event notifications will be pushed for up to 5 minutes afterwards.

  • If an appliance is reset, some data points may also be reset and start counting from 0 (e.g., total energy consumption values).

  • The activation of the distribution of the data point events is done on a per-company basis. A company either receives all or none of the events.

  • The notifications are triggered if the data point value is different from the value previously sent. The restart or downtime of non-critical backend components may trigger the re-sending of repeated data point values.

You will find the list of supported data points here.

Daily Aggregate​

The aggregates are daily notifications, containing properties related to the health status of an appliance:

  • One notification will be generated per day, per gateway and per property, around 13:00 UTC.
  • Each daily aggregate event refers to the previous day, between 00:00 and 23:59.
  • Daily aggregate events will be pushed to the webhook defined by the partner.
  • If an appliance is reset, some properties may also be reset to their default/initial values. For example, the daily aggregates that represent counters will start counting from 0 again.
  • The activation of the daily aggregate events is done on a per-company basis. A company either receives all or none of the events.
  • If there is any issue calculating a daily aggregate, e.g. poor data quality or internal errors, the respective daily aggregate event will not be sent.
    • In case of internal errors while calculating a daily aggregate, the customers will be informed through the existing communication channels. e.g. Slack.

You will find the list of supported daily aggregates here.