Set Grouped Light
philips_hue.set_grouped_light
ActionBusiness appsconnection required
Calls the Philips Hue API with the connection's credentials.
Set every light in a room or zone at once through its grouped-light service.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Philips Hue
- Secret shape
- {"api_key": "…"} (the bridge application key), plus "access_token" for Hue's remote gateway
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
group_id UUID of the grouped-light service to change. It is the 'rid' of the room or zone service whose 'rtype' is 'grouped_light'. | string | Yes | — | — | 4a2ee1a9-5f2a-4b1e-b8bf-1bd1a4d7dd8a |
on Whether the light should be on. Leave unset to keep the current power state. | boolean | No | — | — | — |
brightness Brightness as a percentage of the light's range. Writing 0 sets the lowest brightness the light supports rather than switching it off. | number | No | — | 0–100 | 80 |
mirek White colour temperature in mirek (reciprocal megakelvin): 153 is the coolest daylight white and 500 the warmest candlelight. | number | No | — | 153–500 | 366 |
color_xy Colour as a CIE xy gamut position, an object with an 'x' and a 'y' between 0.0 and 1.0. A light outside its own gamut is clamped by the bridge. | object | No | — | — | {"x":0.4,"y":0.4} |
duration_ms How long the transition to the new state should take, in milliseconds. Left unset, the light changes at its default speed. | number | No | — | 0–21600000 | 1000 |
- At least one of on, brightness, mirek, color_xy must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"brightness": 80,
"color_xy": {
"x": 0.4,
"y": 0.4
},
"duration_ms": 1000,
"group_id": "4a2ee1a9-5f2a-4b1e-b8bf-1bd1a4d7dd8a",
"mirek": 366
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
updated The resource identifiers Hue reports it changed, each an object with a 'rid' and an 'rtype'. | array | — |
count How many resources Hue reports it changed. | number | — |
{
"count": 0,
"updated": []
}Related Philips Hue nodes
See Set Grouped Light run in a workflow.
In a technical demo we add the Philips Hue connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.