Configure

Use this action to change a setting in deCONZ directly through its REST API. You can target a specific device endpoint, like a light or a sensor, or change the configuration of the deCONZ service itself. This is handy when deCONZ exposes a setting that Home Assistant does not surface on its own.

Important

Only users with administrator privileges can run this action.

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 use this action in an automation or script:

  1. Go to Settings > Automations & scenes.
  2. Open an existing automation or script, or select Create to start a new one.
  3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger.
  4. In the Then do section, select Add action.
  5. From the search box, search for and select deCONZ: Configure.
  6. Fill in the options you want to use.
  7. Select Save.

This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label.

Options in the UI

Entity

The Home Assistant entity that represents the device endpoint in deCONZ you want to configure. Provide either an entity or a path.

Path

The full path to a deCONZ endpoint, such as /lights/1/state. When you also provide an entity, this is treated as a subpath of that entity’s device path, such as /state.

Configuration payload

The data you want to change, as a JSON object. For example, {"on": true}.

Bridge identifier

A unique string for each piece of deCONZ hardware. You can find it as part of the integration name. This is useful if you run multiple deCONZ integrations.

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 deconz.configure. A basic example looks like this:

ActionActions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*. [Learn more]
action: deconz.configure
data:
  entity: light.living_room
  data:
    on: true

This turns on the light that the light.living_room entity represents.

Options in YAML

entity string

The Home Assistant entity that represents the device endpoint in deCONZ you want to configure. Provide either an entity or a field.

field string

The full path to a deCONZ endpoint, such as /lights/1/state. When you also provide an entity, this is treated as a subpath of that entity’s device path, such as /state.

data map Required

The data you want to change, as a JSON object. For example, {"on": true}.

bridgeid string

A unique string for each piece of deCONZ hardware. You can find it as part of the integration name. This is useful if you run multiple deCONZ integrations.

Good to know

  • You must provide either an entity or a field. If you provide both, the field is treated as a subpath under the device path of the entity.
  • If you do not provide a bridge identifier and you run more than one deCONZ integration, the action uses your main deCONZ gateway.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.

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.

Tip

AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.

Related actions

These actions work well alongside this one: