2026.6.3
Home ▸ Actions

Invoke a Command Class API on a node

Use this action to call a Command Class API directly on a Z-Wave node. In most cases the Set a value action does what you need, but some command classes have API methods that can’t be reached that way.

Correctly using this action requires advanced knowledge of Z-Wave. Refer to the Z-Wave JS Command Class documentation for the available APIs and their arguments.

You can target the action at one or more entities, devices, or areas. At least one of those must be provided.

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 invoke a Command Class API 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. From the list of actions, search for and select Invoke a Command Class API on a node.
  6. Select the Z-Wave entities, devices, or areas to target, then set the Command class, Method name, and Parameters.
  7. Select Save.

Options in the UI

Area ID(s) (Optional)

The area, or areas, to target. All Z-Wave devices and entities in the area are targeted.
Device ID(s) (Optional)

The device, or devices, to target.
Entity ID(s) (Optional)

The entity, or entities, to target.
Command class (Required)

The ID of the command class you want to issue a command to.
Endpoint (Optional)

The endpoint to call the API on. When set, it is used for all targeted nodes. When not set, the root endpoint (0) is used for devices and areas, and the primary value endpoint is used for each entity.
Method name (Required)

The name of the API method to call.
Parameters (Required)

A list of parameters to pass to the API method.

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 zwave_js.invoke_cc_api. 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: zwave_js.invoke_cc_api
target:
  entity_id: climate.thermostat
data:
  command_class: 132
  method_name: setInterval
  parameters: [1, 1]

Options in YAML

area_id string | list

The area ID, or list of area IDs, to target. All Z-Wave devices and entities in the area are targeted. At least one of entity_id, device_id, or area_id is required.

device_id string | list

The device ID, or list of device IDs, to target. At least one of entity_id, device_id, or area_id is required.

entity_id string | list

The entity ID, or list of entity IDs, to target. At least one of entity_id, device_id, or area_id is required.

command_class integer Required

The ID of the command class you want to issue a command to.

endpoint integer

The endpoint to call the API on. When set, it is used for all targeted nodes. When not set, the root endpoint (0) is used for devices and areas, and the primary value endpoint is used for each entity.

method_name string Required

The name of the API method to call.

parameters list Required

A list of parameters to pass to the API method.

Good to know

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:

  • Set a value: Changes any value that Z-Wave recognizes on a Z-Wave device.