Reload MQTT entities

Use this action to reload the MQTT entities you configured manually in YAML, without restarting Home Assistant. A common use is to apply your changes right after you edit MQTT entities in your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file.

This action only reloads entities you set up through YAML. Entities that are added automatically through MQTT discovery are not affected.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To reload MQTT entities from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Search for and select Reload.
6. Select Save.

Options in the UI

This action has no options.

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as mqtt.reload. It takes no options:

action: mqtt.reload

Options in YAML

This action has no options.

Good to know

• You usually run this action straight from Developer tools > Actions right after editing your MQTT entities, so you can see the result without a restart.
• When the reload finishes, Home Assistant fires an event_mqtt_reloaded event. You can use this event as an automation trigger.
• Only administrators can run this action.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.

Related actions

These actions work well alongside this one:

• Publish an MQTT message: Publishes a message to an MQTT topic.

• Export MQTT messages: Writes all messages on a topic to a file for debugging.