Configure MQTT export in your Workspace

✓ EnergyID for Business

With the MQTT export Workspace feature, you can forward meter data and device data to an external MQTT broker. This lets you combine EnergyID data with your own automation, or integrations in your organization. New to MQTT? Start with the short introduction on mqtt.org.

Building a technical integration? Looking for the exact payload structure and API definitions? Go straight to MQTT export data model and payload format.

Where can you find MQTT export?

  • In your Workspace, go to Configuration.
  • Open the MQTT export feature.
  • Add at least one broker and fill in the settings.
  • Click Save.

Only Workspace administrators can save this configuration.

All settings explained

Broker

You can add one or more brokers. Each broker has its own credentials, topic templates, and forwarding modes.

  • Broker URL: the endpoint of your broker, for example mqtt://broker.example.com:1883 or mqtts://broker.example.com:8883.
  • Username: the username EnergyID uses to sign in to the broker.
  • Password: the password for this username.
    • For an existing broker, you can leave this field empty to keep the stored password.
    • For a new broker, this field is required.

Forwarding modes

  • Forward processed meter data: forwards meter data for each record in the workspace. Data is sent as soon as it has been processed in EnergyID. For integrations that synchronize overnight, forwarding will also happen overnight. Integrations that send continuous updates are forwarded almost immediately.
  • Forward real-time device data: forwards real-time data at device level. Please note: this only applies to integrations that provide real-time data to EnergyID themselves.

Note: You must enable at least one forwarding mode. If both are disabled, the configuration cannot be saved as valid.

Topic templates

For each mode, you decide which MQTT topic receives the messages.

  • Topic template for meter data (default): energyid/workspace/{{workspaceId}}/record/{{recordNumber}}/meter/{{meterId}}
  • Topic template for device data (default): energyid/workspace/{{workspaceId}}/record/{{recordNumber}}/device/{{twinId}}

The placeholders are replaced automatically during publication. All available placeholders are listed in the example template. You do not have to use placeholders.

GDPR / legal basis confirmation

For each broker, you must confirm that a valid legal basis exists for sharing energy data with that MQTT subscriber. Without this confirmation, you cannot save the configuration.

In practice, this means at minimum that your processing complies with GDPR (Regulation (EU) 2016/679), including:

  • a valid legal basis for processing (GDPR, Article 6),
  • a data processing agreement when the broker operator acts as a processor (GDPR, Article 28),
  • transparency towards data subjects about disclosure to third parties (GDPR, Articles 13 and 14).

Depending on your setup, additional rules may apply, such as sector-specific obligations or national implementing rules within the EU/EEA.

Which error messages can you see?

Validation when saving

If the configuration is incomplete, you may see validation issues while saving, for example:

  • No broker added.
  • A required field is missing (broker URL, username, or password for a new broker).
  • No forwarding mode enabled.
  • Confirmation of the legal basis (GDPR) is missing.

Delivery failure during publishing

If publishing to a broker fails, that broker shows a Delivery failure badge. You can click it for more information. In the detail view, you can see:

  • the time of the most recent error,
  • the technical error message from the broker connection or publication.

When the first error occurs for a broker, Workspace administrators also receive a message in the message center.

Note: When you save the MQTT settings again, the last known delivery failure is cleared. So make sure to review the error details before saving again. If another error occurs after updating the settings, you will receive a new notification.

Full data formats per mode

This page explains the settings and error messages. The exact payload structure for each forwarding mode (meter data and device data), including example messages and field descriptions, is documented on a separate technical page:

MQTT export data model and payload format

Frequently asked questions

Can I configure multiple brokers at the same time?

Yes. Each broker is saved and used independently. You can set different topic templates and forwarding modes per broker.

Do I need to enter my password again for every change?

No. For existing brokers, you can leave the password field empty to keep the current password.

Why do I see an active configuration but still no messages?

Check the delivery failure per broker, the broker URL, the access rights of the MQTT user, and whether at least one forwarding mode is active.