openHAB
App · 32 actions
Run your smart home from a workflow: switch lights and devices, set levels, run scenes and scripts, read sensors and their history, and check which devices are offline. Start a workflow when an item changes, a reading passes a number, a device goes offline or openHAB finds a new one.
Actions
| Action | What it does |
|---|---|
| Add item to group | Put an item in a group, keeping the groups it is in. |
| Add tag to item | Add a tag to an item, keeping the tags it has. |
| Create or update item | Create an item, or change one that exists: its label, icon, tags and groups. |
| Delete item | Delete an item for good. |
| Disable rule | Turn a rule, scene or script off, so nothing starts it until it is enabled again, such as while you're on holiday. |
| Disable thing | Turn a thing off, so openHAB stops talking to it until it is enabled again. |
| Enable rule | Turn a rule, scene or script back on. |
| Enable thing | Turn a thing back on, so openHAB talks to it again. |
| Get item | Get an item with what it shows now, what it showed before, its tags, groups, members and metadata. |
| Get item history | Get what an item was between two times, as openHAB stored it, with the lowest, highest and average for numbers. |
| Get item state | Get only what an item shows now, such as ON or 21.5 °C, with the number and unit read out of it. |
| Get last stored state | Get the newest value openHAB stored for an item and when, looking back up to a year. |
| Get rule | Get a rule, scene or script with what starts it and what it does. |
| Get system info | Get the openHAB server's version, language, time zone, how long it has been running and its memory. |
| Get thing | Get a thing with whether it is online and why not, its channels with the items linked to them, and its settings. |
| List add-ons | List the add-ons installed in openHAB with their versions, or everything its Add-on Store offers. |
| List discovered things | List what openHAB has found on the network and keeps in its inbox, waiting to be added. |
| List items | List items (lights, sensors, switches and the rest) with what each shows now, all of them or only one type, tag or group. |
| List rules | List rules, scenes and scripts, with whether each is turned on. |
| List things | List things (the devices and services openHAB talks to) with whether each is online and, when it isn't, why. |
| Remove item from group | Take an item out of a group. |
| Remove item metadata | Remove one piece of an item's metadata. |
| Remove tag from item | Take a tag off an item. |
| Run rule | Run a rule, a scene or a script now, whatever usually starts it, such as a Good night scene. |
| Say text | Have openHAB say something out loud through a speaker it knows. |
| Send command | Tell an item, and the device behind it, to do something: ON or OFF, a number, UP, DOWN or STOP for blinds, PLAY or PAUSE, a colour, or text. |
| Set item metadata | Set one piece of an item's metadata, such as its unit or what a voice assistant calls it, replacing what was there. |
| Set level | Set a dimmer's brightness, a blind's position or a volume, from 0 to 100 percent. |
| Tell openHAB in words | Give openHAB a command in plain words, such as turn on the hall light, and get its answer. |
| Turn off | Turn off a light, a switch or a group of them. |
| Turn on | Turn on a light, a switch or a group of them. |
| Update item state | Change what an item shows without telling its device to do anything, such as a text item with a status, or a number worked out in a workflow. |
Add item to group
Put an item in a group, keeping the groups it is in.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Group
grouptextRequired - The group: pick one, or give its name from another openHAB step or its label, such as Lights.
Outputs
categorytext- Its icon, such as lightbulb
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}Add tag to item
Add a tag to an item, keeping the tags it has.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Tag
tagtextRequired - The tag, such as Light.
Outputs
categorytext- Its icon, such as lightbulb
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}Create or update item
Create an item, or change one that exists: its label, icon, tags and groups. What you leave blank on an item that exists stays as it is.
Inputs
- Name
nametextRequired - The item's name: letters, numbers and underscores, such as Kitchen_Light. An item with this name is changed; otherwise one is created.
- Type
item_typetext - What kind of item it is. Needed to create one.One of:
Switch(Switch (on or off)),Dimmer(Dimmer (0 to 100 percent)),Number,String(String (text)),Contact(Contact (open or closed)),Rollershutter(Rollershutter (blinds)),Color,DateTime(DateTime (date and time)),Player(Player (play and pause)),Location, and 3 more. - Label
labeltext - The name people see, such as Kitchen Light.
- Icon
categorytext - Its icon in openHAB, such as lightbulb.
- Tags
tagslist - Its tags, such as Light. These replace the tags it had.
- Groups
groupslist - The names of the groups it belongs to, such as Lights. These replace the groups it was in.
- Dimension
dimensiontext - For a Number with a unit, what it measures, such as Temperature, Power or Length.
Outputs
categorytext- Its icon, such as lightbulb
createdtrue/false- Whether the item was created (false when it was changed)
group_typetext- For a group, the kind of item it adds up to, or blank
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
memberslist- For a group, the names of the items in it
metadataobject- The item's metadata: for each kind (such as unit), its value and config
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"created": true,
"group_type": "",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"members": [],
"metadata": {
"semantics": {
"config": {},
"value": "Point_Control"
}
},
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}Delete item
Delete an item for good. Items defined in a file on the server can't be deleted this way.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
Outputs
deletedtrue/false- Whether it was deleted
labeltext- The label it had
nametext- The deleted item's name
Example output
{
"deleted": true,
"label": "Kitchen Light",
"name": "Kitchen_Light"
}Disable rule
Turn a rule, scene or script off, so nothing starts it until it is enabled again, such as while you're on holiday.
Inputs
- Rule
ruletextRequired - The rule, scene or script: pick one, or give its ID from another openHAB step or its name.
Outputs
descriptiontext- Its description
enabledtrue/false- Whether it is turned on
linktext- Where it opens in openHAB
nametext- The rule's name
rule_typetext- rule, scene or script
statustext- IDLE, RUNNING, INITIALIZING or UNINITIALIZED
status_detailtext- Why, in openHAB's word, such as DISABLED; blank when there's nothing to say
tagslist- Its tags
uidtext- The rule's ID, which other openHAB steps take
Example output
{
"description": "Lamp on, dimmer low",
"enabled": false,
"link": "https://openhab.example.com/settings/scenes/evening_scene",
"name": "Evening",
"rule_type": "scene",
"status": "UNINITIALIZED",
"status_detail": "DISABLED",
"tags": [
"Scene"
],
"uid": "evening_scene"
}Disable thing
Turn a thing off, so openHAB stops talking to it until it is enabled again.
Inputs
- Thing
thingtextRequired - The thing (a device or service openHAB talks to): pick one, or give its ID from another openHAB step or its label.
Outputs
bridgetext- The ID of the bridge it connects through, or blank
enabledtrue/false- Whether the thing is turned on in openHAB
labeltext- The thing's label
linktext- Where the thing opens in openHAB
locationtext- Where it is, when set
onlinetrue/false- Whether the thing is online
statustext- ONLINE, OFFLINE, UNINITIALIZED, INITIALIZING, UNKNOWN or REMOVING
status_descriptiontext- Why, in the thing's own words, when it says
status_detailtext- Why, in openHAB's word, such as COMMUNICATION_ERROR or DISABLED; blank when there's nothing to say
thing_typetext- What kind of thing it is, such as astro:sun
uidtext- The thing's ID, which other openHAB steps take
Example output
{
"bridge": "hue:bridge:bridge1",
"enabled": false,
"label": "Hallway Lamp",
"link": "https://openhab.example.com/settings/things/hue:0210:bridge1:lamp3",
"location": "Hallway",
"online": false,
"status": "UNINITIALIZED",
"status_description": "",
"status_detail": "DISABLED",
"thing_type": "hue:0210",
"uid": "hue:0210:bridge1:lamp3"
}Enable rule
Turn a rule, scene or script back on.
Inputs
- Rule
ruletextRequired - The rule, scene or script: pick one, or give its ID from another openHAB step or its name.
Outputs
descriptiontext- Its description
enabledtrue/false- Whether it is turned on
linktext- Where it opens in openHAB
nametext- The rule's name
rule_typetext- rule, scene or script
statustext- IDLE, RUNNING, INITIALIZING or UNINITIALIZED
status_detailtext- Why, in openHAB's word, such as DISABLED; blank when there's nothing to say
tagslist- Its tags
uidtext- The rule's ID, which other openHAB steps take
Example output
{
"description": "Lamp on, dimmer low",
"enabled": true,
"link": "https://openhab.example.com/settings/scenes/evening_scene",
"name": "Evening",
"rule_type": "scene",
"status": "IDLE",
"status_detail": "",
"tags": [
"Scene"
],
"uid": "evening_scene"
}Enable thing
Turn a thing back on, so openHAB talks to it again.
Inputs
- Thing
thingtextRequired - The thing (a device or service openHAB talks to): pick one, or give its ID from another openHAB step or its label.
Outputs
bridgetext- The ID of the bridge it connects through, or blank
enabledtrue/false- Whether the thing is turned on in openHAB
labeltext- The thing's label
linktext- Where the thing opens in openHAB
locationtext- Where it is, when set
onlinetrue/false- Whether the thing is online
statustext- ONLINE, OFFLINE, UNINITIALIZED, INITIALIZING, UNKNOWN or REMOVING
status_descriptiontext- Why, in the thing's own words, when it says
status_detailtext- Why, in openHAB's word, such as COMMUNICATION_ERROR or DISABLED; blank when there's nothing to say
thing_typetext- What kind of thing it is, such as astro:sun
uidtext- The thing's ID, which other openHAB steps take
Example output
{
"bridge": "hue:bridge:bridge1",
"enabled": true,
"label": "Hallway Lamp",
"link": "https://openhab.example.com/settings/things/hue:0210:bridge1:lamp3",
"location": "Hallway",
"online": true,
"status": "ONLINE",
"status_description": "The lamp isn't reachable.",
"status_detail": "",
"thing_type": "hue:0210",
"uid": "hue:0210:bridge1:lamp3"
}Get item
Get an item with what it shows now, what it showed before, its tags, groups, members and metadata.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
Outputs
categorytext- Its icon, such as lightbulb
group_typetext- For a group, the kind of item it adds up to, or blank
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
memberslist- For a group, the names of the items in it
metadataobject- The item's metadata: for each kind (such as unit), its value and config
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"group_type": "",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"members": [],
"metadata": {
"semantics": {
"config": {},
"value": "Point_Control"
}
},
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}Get item history
Get what an item was between two times, as openHAB stored it, with the lowest, highest and average for numbers. Needs a persistence add-on in openHAB.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- From
startdate and time - The start of the time. Defaults to a day before the end.
- To
enddate and time - The end of the time. Defaults to now.
- Persistence service
servicetext - Where openHAB stored it, such as rrd4j. Leave blank for openHAB's default.
- How many
limitnumber - The most values to return, keeping the newest. Defaults to 1000.From 1 to 10000.
Outputs
averagenumber- The average of the numbers, empty when there are none
countnumber- How many values are listed
datapointslist- Each stored value, oldest first
endtext- The end of the time looked at (UTC)
first_statetext- The oldest value listed
last_statetext- The newest value listed
maximumnumber- The highest number, empty when none are numbers
minimumnumber- The lowest number, empty when none are numbers
moretrue/false- Whether older values in that time were left out
nametext- The item's name
starttext- The start of the time looked at (UTC)
Example output
{
"average": 385,
"count": 2,
"datapoints": [
{
"number": 360,
"state": "360",
"time": "2026-11-12T08:00:00Z"
},
{
"number": 410,
"state": "410",
"time": "2026-11-12T12:00:00Z"
}
],
"end": "2026-11-12T18:30:00Z",
"first_state": "360",
"last_state": "410",
"maximum": 410,
"minimum": 360,
"more": false,
"name": "Power_Meter",
"start": "2026-11-11T18:30:00Z"
}Get item state
Get only what an item shows now, such as ON or 21.5 °C, with the number and unit read out of it.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
Outputs
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
unittext- The unit of that number, such as °C, or blank
Example output
{
"has_state": true,
"name": "LivingRoom_Temperature",
"number": 21.5,
"state": "21.5 \u00b0C",
"unit": "\u00b0C"
}Get last stored state
Get the newest value openHAB stored for an item and when, looking back up to a year. Says so when nothing was stored.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Persistence service
servicetext - Where openHAB stored it, such as rrd4j. Leave blank for openHAB's default.
Outputs
foundtrue/false- Whether anything was stored for it in the past year
nametext- The item's name
numbernumber- The value as a number (1 for ON, 0 for OFF), empty when it isn't one
statetext- The value, as openHAB stored it
timetext- When the value was stored (UTC)
Example output
{
"found": true,
"name": "Power_Meter",
"number": 410,
"state": "410",
"time": "2026-11-12T12:00:00Z"
}Get rule
Get a rule, scene or script with what starts it and what it does.
Inputs
- Rule
ruletextRequired - The rule, scene or script: pick one, or give its ID from another openHAB step or its name.
Outputs
actionslist- What it does
conditionslist- What must be true for it to run
descriptiontext- Its description
enabledtrue/false- Whether it is turned on
linktext- Where it opens in openHAB
nametext- The rule's name
rule_typetext- rule, scene or script
statustext- IDLE, RUNNING, INITIALIZING or UNINITIALIZED
status_detailtext- Why, in openHAB's word, such as DISABLED; blank when there's nothing to say
tagslist- Its tags
triggerslist- What starts it
uidtext- The rule's ID, which other openHAB steps take
Example output
{
"actions": [
{
"configuration": {
"command": "ON",
"itemName": "LivingRoom_Lamp"
},
"id": "1",
"label": "",
"type": "core.ItemCommandAction"
}
],
"conditions": [],
"description": "Lamp on, dimmer low",
"enabled": true,
"link": "https://openhab.example.com/settings/scenes/evening_scene",
"name": "Evening",
"rule_type": "scene",
"status": "IDLE",
"status_detail": "",
"tags": [
"Scene"
],
"triggers": [],
"uid": "evening_scene"
}Get system info
Get the openHAB server's version, language, time zone, how long it has been running and its memory.
Inputs
None.
Outputs
api_versiontext- The version of its API
buildtext- Which build it is, such as Release Build
java_versiontext- The Java version it runs on
languagetext- Its language and region, such as en_US
linktext- openHAB's About page
measurement_systemtext- SI (metric) or US
memory_free_mbnumber- Memory openHAB has free, in megabytes
memory_total_mbnumber- Memory openHAB has taken, in megabytes
operating_systemtext- The system it runs on
time_zonetext- Its time zone, such as Europe/Berlin
uptime_secondsnumber- How long it has been running, in seconds
versiontext- openHAB's version, such as 5.2.4
Example output
{
"api_version": "8",
"build": "Release Build",
"java_version": "21.0.13",
"language": "en_US",
"link": "https://openhab.example.com/about",
"measurement_system": "SI",
"memory_free_mb": 120.5,
"memory_total_mb": 512,
"operating_system": "Linux 6.12",
"time_zone": "Europe/Berlin",
"uptime_seconds": 86400,
"version": "5.2.4"
}Get thing
Get a thing with whether it is online and why not, its channels with the items linked to them, and its settings.
Inputs
- Thing
thingtextRequired - The thing (a device or service openHAB talks to): pick one, or give its ID from another openHAB step or its label.
Outputs
bridgetext- The ID of the bridge it connects through, or blank
channelslist- What the thing offers, each with the items linked to it
configurationobject- The thing's settings
enabledtrue/false- Whether the thing is turned on in openHAB
labeltext- The thing's label
linktext- Where the thing opens in openHAB
locationtext- Where it is, when set
onlinetrue/false- Whether the thing is online
propertiesobject- What the thing reports about itself, such as its model
statustext- ONLINE, OFFLINE, UNINITIALIZED, INITIALIZING, UNKNOWN or REMOVING
status_descriptiontext- Why, in the thing's own words, when it says
status_detailtext- Why, in openHAB's word, such as COMMUNICATION_ERROR or DISABLED; blank when there's nothing to say
thing_typetext- What kind of thing it is, such as astro:sun
uidtext- The thing's ID, which other openHAB steps take
Example output
{
"bridge": "hue:bridge:bridge1",
"channels": [
{
"id": "brightness",
"item_type": "Dimmer",
"label": "Brightness",
"linked_items": [
"Hall_Light"
]
}
],
"configuration": {
"lightId": "3"
},
"enabled": true,
"label": "Hallway Lamp",
"link": "https://openhab.example.com/settings/things/hue:0210:bridge1:lamp3",
"location": "Hallway",
"online": false,
"properties": {
"modelId": "LWB010"
},
"status": "OFFLINE",
"status_description": "The lamp isn't reachable.",
"status_detail": "COMMUNICATION_ERROR",
"thing_type": "hue:0210",
"uid": "hue:0210:bridge1:lamp3"
}List add-ons
List the add-ons installed in openHAB with their versions, or everything its Add-on Store offers.
Inputs
- Type
addon_typetext - Only add-ons of this kind. Defaults to all kinds.One of:
all(All kinds),binding(Bindings),automation,persistence,transformation(Transformations),ui(User interfaces),voice,misc(Other). Default:all. - Include not installed
include_availabletrue/false - Also list add-ons that could be installed.Default:
false. - Name contains
wordstext - Only those whose name has these words.
Outputs
addonslist- Each add-on, A to Z by name
countnumber- How many are listed
texttext- The list as text, one per line
Example output
{
"addons": [
{
"addon_type": "binding",
"author": "openHAB",
"description": "Sunrise, sunset and moon phases.",
"id": "binding-astro",
"installed": true,
"link": "https://www.openhab.org/addons/bindings/astro/",
"name": "Astro Binding",
"version": "5.2.4"
}
],
"count": 1,
"text": "- Astro Binding (binding, 5.2.4)"
}List discovered things
List what openHAB has found on the network and keeps in its inbox, waiting to be added.
Inputs
None.
Outputs
countnumber- How many are listed
texttext- The list as text, one per line
thingslist- Each thing waiting in openHAB's inbox
Example output
{
"count": 1,
"text": "- Hue Bridge (hue:bridge:001788fffe2b3c4d)",
"things": [
{
"binding": "hue",
"bridge": "",
"ignored": false,
"label": "Hue Bridge",
"properties": {
"ipAddress": "192.168.1.20"
},
"thing_type": "hue:bridge",
"uid": "hue:bridge:001788fffe2b3c4d"
}
]
}List items
List items (lights, sensors, switches and the rest) with what each shows now, all of them or only one type, tag or group.
Inputs
- Type
item_typetext - Only items of this type. Number also finds numbers with a unit.One of:
Switch(Switch (on or off)),Dimmer(Dimmer (0 to 100 percent)),Number,String(String (text)),Contact(Contact (open or closed)),Rollershutter(Rollershutter (blinds)),Color,DateTime(DateTime (date and time)),Player(Player (play and pause)),Location, and 3 more. - Tag
tagtext - Only items with this tag, such as Light.
- Group
grouptext - Only items in this group or the groups inside it, such as Lights.
- Name contains
wordstext - Only those whose name has these words.
- How many
limitnumber - The most items to return. Defaults to 200.From 1 to 2000.
Outputs
countnumber- How many items are listed
itemslist- Each item, A to Z by label
moretrue/false- Whether there were more than the most asked for
texttext- The list as text, one item per line, to send to someone
Example output
{
"count": 1,
"items": [
{
"category": "lightbulb",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}
],
"more": false,
"text": "- Living Room Lamp (LivingRoom_Lamp): ON"
}List rules
List rules, scenes and scripts, with whether each is turned on.
Inputs
- Show
rule_typetext - Only rules, only scenes or only scripts. Defaults to everything.One of:
all(Everything),rule(Rules),scene(Scenes),script(Scripts). Default:all. - Tag
tagtext - Only those with this tag.
- Name contains
wordstext - Only those whose name has these words.
Outputs
countnumber- How many are listed
ruleslist- Each rule, scene or script, A to Z by name
texttext- The list as text, one per line
Example output
{
"count": 1,
"rules": [
{
"description": "Lamp on, dimmer low",
"enabled": true,
"link": "https://openhab.example.com/settings/scenes/evening_scene",
"name": "Evening",
"rule_type": "scene",
"status": "IDLE",
"status_detail": "",
"tags": [
"Scene"
],
"uid": "evening_scene"
}
],
"text": "- Evening (scene evening_scene)"
}List things
List things (the devices and services openHAB talks to) with whether each is online and, when it isn't, why.
Inputs
- Status
statustext - Only things that are online, offline or turned off. Defaults to all.One of:
all,online,offline,disabled. Default:all. - Name contains
wordstext - Only those whose name has these words.
Outputs
countnumber- How many things are listed
offline_countnumber- How many of them are offline
texttext- The list as text, one thing per line, to send to someone
thingslist- Each thing, A to Z by label
Example output
{
"count": 1,
"offline_count": 1,
"text": "- Hallway Lamp (hue:0210:bridge1:lamp3): OFFLINE (The lamp isn't reachable.)",
"things": [
{
"bridge": "hue:bridge:bridge1",
"enabled": true,
"label": "Hallway Lamp",
"link": "https://openhab.example.com/settings/things/hue:0210:bridge1:lamp3",
"location": "Hallway",
"online": false,
"status": "OFFLINE",
"status_description": "The lamp isn't reachable.",
"status_detail": "COMMUNICATION_ERROR",
"thing_type": "hue:0210",
"uid": "hue:0210:bridge1:lamp3"
}
]
}Remove item from group
Take an item out of a group.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Group
grouptextRequired - The group: pick one, or give its name from another openHAB step or its label, such as Lights.
Outputs
categorytext- Its icon, such as lightbulb
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"groups": [
"LivingRoom"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}Remove item metadata
Remove one piece of an item's metadata. Says so when there was none.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Metadata
namespacetextRequired - Which metadata, by openHAB's name for it, such as unit, stateDescription or alexa.
Outputs
nametext- The item's name
namespacetext- Which metadata was removed, such as unit
removedtrue/false- Whether there was any to remove
Example output
{
"name": "LivingRoom_Temperature",
"namespace": "unit",
"removed": true
}Remove tag from item
Take a tag off an item.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Tag
tagtextRequired - The tag, such as Light.
Outputs
categorytext- Its icon, such as lightbulb
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [],
"type": "Switch",
"unit": ""
}Run rule
Run a rule, a scene or a script now, whatever usually starts it, such as a Good night scene.
Inputs
- Rule
ruletextRequired - The rule, scene or script: pick one, or give its ID from another openHAB step or its name.
Outputs
descriptiontext- Its description
enabledtrue/false- Whether it is turned on
linktext- Where it opens in openHAB
nametext- The rule's name
rule_typetext- rule, scene or script
startedtrue/false- Whether openHAB started it
statustext- IDLE, RUNNING, INITIALIZING or UNINITIALIZED
status_detailtext- Why, in openHAB's word, such as DISABLED; blank when there's nothing to say
tagslist- Its tags
uidtext- The rule's ID, which other openHAB steps take
Example output
{
"description": "Lamp on, dimmer low",
"enabled": true,
"link": "https://openhab.example.com/settings/scenes/evening_scene",
"name": "Evening",
"rule_type": "scene",
"started": true,
"status": "IDLE",
"status_detail": "",
"tags": [
"Scene"
],
"uid": "evening_scene"
}Say text
Have openHAB say something out loud through a speaker it knows. Needs a text-to-speech add-on and a speaker set up in openHAB.
Inputs
- Text
texttextRequired - What to say, such as The washing is done.
- Voice
voicetext - The voice's ID in openHAB. Leave blank for openHAB's default.
- Speaker
speakertext - The ID of the speaker (audio sink) in openHAB. Leave blank for openHAB's default.
- Volume
volumenumber - How loud, from 0 to 100 percent.From 0 to 100.
Outputs
senttrue/false- Whether openHAB took the request
texttext- What openHAB was asked to say
Example output
{
"sent": true,
"text": "The washing is done"
}Send command
Tell an item, and the device behind it, to do something: ON or OFF, a number, UP, DOWN or STOP for blinds, PLAY or PAUSE, a colour, or text.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Command
commandtextRequired - What to send, as openHAB takes it: ON, OFF, 50, UP, DOWN, STOP, PLAY, PAUSE, a colour as hue,saturation,brightness such as 120,100,50, or any text.
Outputs
categorytext- Its icon, such as lightbulb
commandtext- The command openHAB was sent, such as ON or 50
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"command": "ON",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}Set item metadata
Set one piece of an item's metadata, such as its unit or what a voice assistant calls it, replacing what was there.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- Metadata
namespacetextRequired - Which metadata, by openHAB's name for it, such as unit, stateDescription or alexa.
- Value
valuetextRequired - The value, such as °C.
- Settings
configobject - Extra fields and values it takes, such as pattern: %.1f °C.
Outputs
configobject- Its extra settings
nametext- The item's name
namespacetext- Which metadata was set, such as unit
valuetext- Its value
Example output
{
"config": {},
"name": "LivingRoom_Temperature",
"namespace": "unit",
"value": "\u00b0C"
}Set level
Set a dimmer's brightness, a blind's position or a volume, from 0 to 100 percent.
Inputs
- Item
itemtextRequired - The dimmer, blind or volume: pick one, or give its name from another openHAB step or its label, such as Hall_Dimmer.
- Level
levelnumberRequired - From 0 to 100 percent, such as 50.From 0 to 100.
Outputs
categorytext- Its icon, such as lightbulb
commandtext- The command openHAB was sent, such as ON or 50
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"command": "50",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Dimmer",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Dimmer",
"number": 50,
"previous_state": "OFF",
"state": "50",
"tags": [
"Light"
],
"type": "Dimmer",
"unit": ""
}Tell openHAB in words
Give openHAB a command in plain words, such as turn on the hall light, and get its answer. openHAB matches the words to your items' labels.
Inputs
- Text
texttextRequired - What to tell it, such as turn off the kitchen light.
- Language
languagetext - The language it's in, such as en, de, fr or es. Defaults to en.
- Interpreter
interpretertext - The ID of another interpreter set up in openHAB, such as a chat add-on's. Leave blank for openHAB's built-in one.
Outputs
answertext- What openHAB answered, such as Ok.
texttext- What openHAB was told
understoodtrue/false- Whether openHAB understood it and acted
Example output
{
"answer": "Ok.",
"text": "turn on the hall light",
"understood": true
}Turn off
Turn off a light, a switch or a group of them.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
Outputs
categorytext- Its icon, such as lightbulb
commandtext- The command openHAB was sent, such as ON or 50
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"command": "OFF",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "OFF",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}Turn on
Turn on a light, a switch or a group of them.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
Outputs
categorytext- Its icon, such as lightbulb
commandtext- The command openHAB was sent, such as ON or 50
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"command": "ON",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}Update item state
Change what an item shows without telling its device to do anything, such as a text item with a status, or a number worked out in a workflow.
Inputs
- Item
itemtextRequired - The item: pick one, or give its name from another openHAB step or its label, such as LivingRoom_Lamp.
- State
statetextRequired - What it should show, such as OPEN, 21.5 or any text. NULL clears it.
Outputs
categorytext- Its icon, such as lightbulb
groupslist- The groups it belongs to, by name
has_statetrue/false- Whether the item has a value (not NULL or UNDEF)
is_grouptrue/false- Whether the item is a group of other items
labeltext- The item's label, as people see it
last_changedtext- When its state last changed (UTC), or blank
last_updatedtext- When it last received a state (UTC), or blank
linktext- Where the item opens in openHAB
nametext- The item's name, which other openHAB steps take
numbernumber- The state as a number, empty when it isn't one
previous_statetext- What it showed before its last change
statetext- What the item shows now, as openHAB gives it, such as ON, 40 or 21.5 °C; NULL or UNDEF when it has no value
tagslist- Its tags, such as Light
typetext- What kind of item it is, such as Switch, Dimmer or Number
unittext- The unit of that number, such as °C, or blank
Example output
{
"category": "lightbulb",
"groups": [
"LivingRoom",
"Lights"
],
"has_state": true,
"is_group": false,
"label": "Living Room Lamp",
"last_changed": "2026-11-12T18:30:00Z",
"last_updated": "2026-11-12T18:30:00Z",
"link": "https://openhab.example.com/settings/items/LivingRoom_Lamp",
"name": "LivingRoom_Lamp",
"number": null,
"previous_state": "OFF",
"state": "ON",
"tags": [
"Light"
],
"type": "Switch",
"unit": ""
}