Set Light

philips_hue.set_light
ActionBusiness appsconnection required

Calls the Philips Hue API with the connection's credentials.

Turn one light on or off and set its brightness, colour temperature or colour.

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.

FieldTypeRequiredDefaultConstraintsExample
light_id
UUID of the light to change, as returned in the 'id' of a philips_hue.list_lights row.
stringYes——3883f8bf-30a3-445b-ac06-b047d50599df
on
Whether the light should be on. Leave unset to keep the current power state.
booleanNo———
brightness
Brightness as a percentage of the light's range. Writing 0 sets the lowest brightness the light supports rather than switching it off.
numberNo—0–10080
mirek
White colour temperature in mirek (reciprocal megakelvin): 153 is the coolest daylight white and 500 the warmest candlelight.
numberNo—153–500366
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.
objectNo——{"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.
numberNo—0–216000001000
  • 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,
  "light_id": "3883f8bf-30a3-445b-ac06-b047d50599df",
  "mirek": 366
}

Output

One shape.

result

FieldTypeExample
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": []
}

See Set 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.