Philips HUE (Independent Publisher)
Philips HUE allows you to control smart home devices, like lights, switches, plugs and more built by Philips.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Tomasz Poszytek |
| URL | https://aka.ms/poszytek |
| tomasz@poszytek.eu |
| Connector Metadata | |
|---|---|
| Publisher | Tomasz Poszytek |
| Website | https://www.philips-hue.com/ |
| Privacy policy | https://www.philips-hue.com/en-us/support/legal/privacy-policy |
| Categories | Internet of Things;Lifestyle and Entertainment |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| HUE application key | securestring | The API Key that is returned after performing PUT and POST authorization calls. | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Delete scene |
Delete specific scene. |
| Execute device |
Execute a specific device. |
| Execute light |
Execute device having lightning capabilities. |
| Get device |
Get details of a specific device. |
| Get devices |
Get list of all your devices. |
| Get light |
Get details of a specific device having lightning capabilities. |
| Get lights |
Get list of your devices having lightning capabilities. |
| Get rooms |
Get list of rooms (groups). |
| Get scene |
Get details of a specific scene. |
| Get scenes |
Get a list of all scenes. Scenes are used to store and recall settings for a group of lights. |
Delete scene
Delete specific scene.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Scene Id
|
SceneId | True | string |
Id of a scene to delete. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
Updated scenes. |
|
rid
|
data.rid | string |
The unique id of the deleted scene. |
|
rtype
|
data.rtype | string |
The type of the deleted scene. |
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
Execute device
Execute a specific device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Device Id
|
DeviceId | True | string |
Id of a device to update metadata. |
|
Archetype
|
archetype | string |
By default archetype given by manufacturer. |
|
|
Name
|
name | string |
Human readable name of a resource (max. 32 characters). |
|
|
Action
|
action | string |
Type "identify" to trigger identification. Bridge performs Zigbee LED identification cycles for 5 seconds. Lights perform one breathe cycle. Sensors perform LED identification cycles for 15 seconds. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
Updated devices. |
|
rid
|
data.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.rtype | string |
The type of the referenced resource. |
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
Execute light
Execute device having lightning capabilities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Device Id
|
DeviceId | True | string |
Id of a device to update properties. |
|
Name
|
name | string |
MinLength: 1 - maxLength: 32. Human readable name of a resource. |
|
|
On
|
on | boolean |
On/Off state of the light on=true, off=false. |
|
|
Brightness
|
brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
|
Mirek
|
mirek | integer |
Minimum: 153 - maximum: 500. Color temperature in mirek or null when the light color is not in the ct spectrum. |
|
|
X
|
x | float |
Minimum: 0 - maximum: 1. X position in color gamut. |
|
|
Y
|
y | float |
Minimum: 0 - maximum: 1. Y position in color gamut. |
|
|
Speed
|
speed | float |
Minimum: 0 - maximum: 1. Speed of dynamic palette. The speed is valid for the dynamic palette if the status is dynamic_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid. |
|
|
Duration
|
duration | integer |
Maximum: 6000000. Duration of a light transition in ms. Accuracy is in 100ms steps. |
|
|
Action
|
action | string |
One of the available actions to execute on a device. I.e. "breathe". |
|
|
X
|
x | float |
Minimum: 0 - maximum: 1. X position in color gamut. |
|
|
Y
|
y | float |
Minimum: 0 - maximum: 1. Y position in color gamut. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
rid
|
data.rid | string |
rid |
|
rtype
|
data.rtype | string |
rtype |
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
Get device
Get details of a specific device.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Device Id
|
DeviceId | True | string |
Id of a device to display details. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
|
data
|
data | array of object |
Devices matching given ID. |
|
Id
|
data.id | string |
Unique identifier representing a specific resource instance. |
|
Id v1
|
data.id_v1 | string |
Clip v1 resource identifier (to be used in API v1). |
|
Archetype
|
data.metadata.archetype | string |
Default archetype given by manufacturer. |
|
Name
|
data.metadata.name | string |
Human readable name of a resource. |
|
Certified
|
data.product_data.certified | boolean |
This device is HUE certified. |
|
Manufacturer name
|
data.product_data.manufacturer_name | string |
Name of device manufacturer. |
|
Model Id
|
data.product_data.model_id | string |
unique identification of device model. |
|
Product archetype
|
data.product_data.product_archetype | string |
Archetype of the product. |
|
Product name
|
data.product_data.product_name | string |
Name of the product. |
|
Software version
|
data.product_data.software_version | string |
Software version of the product. |
|
Services
|
data.services | array of object |
References all services aggregating control and state of children in the group. |
|
rid
|
data.services.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.services.rtype | string |
The type of the referenced resource. |
|
Type
|
data.type | string |
Type of the supported resource. |
Get devices
Get list of all your devices.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
|
data
|
data | array of object |
User devices. |
|
Id
|
data.id | string |
Unique identifier representing a specific resource instance. |
|
Id v1
|
data.id_v1 | string |
Clip v1 resource identifier (to be used in API v1). |
|
Archetype
|
data.metadata.archetype | string |
Default archetype given by manufacturer. |
|
Name
|
data.metadata.name | string |
Human readable name of a resource. |
|
Certified
|
data.product_data.certified | boolean |
This device is HUE certified. |
|
Manufacturer name
|
data.product_data.manufacturer_name | string |
Name of device manufacturer. |
|
Model Id
|
data.product_data.model_id | string |
unique identification of device model. |
|
Product archetype
|
data.product_data.product_archetype | string |
Archetype of the product. |
|
Product name
|
data.product_data.product_name | string |
Name of the product. |
|
Software version
|
data.product_data.software_version | string |
Software version of the product. |
|
Services
|
data.services | array of object |
References all services aggregating control and state of children in the group. |
|
rid
|
data.services.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.services.rtype | string |
The type of the referenced resource. |
|
Type
|
data.type | string |
Type of the supported resource. |
Get light
Get details of a specific device having lightning capabilities.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Device Id
|
DeviceId | True | string |
Id of a device to display details. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
|
data
|
data | array of object |
Lights matching given ID. |
|
Action values
|
data.alert.action_values | array of string |
List of alert effects that the light supports. |
|
Blue X
|
data.color.gamut.blue.x | float |
X position in color gamut. |
|
Blue Y
|
data.color.gamut.blue.y | float |
Y position in color gamut. |
|
Green X
|
data.color.gamut.green.x | float |
X position in color gamut. |
|
Green Y
|
data.color.gamut.green.y | float |
X position in color gamut. |
|
Red X
|
data.color.gamut.red.x | float |
X position in color gamut. |
|
Red Y
|
data.color.gamut.red.y | float |
X position in color gamut. |
|
Gamut type
|
data.color.gamut_type | string |
The gamut types supported by hue: A - Gamut of early Philips color-only products, B - Limited gamut of first Hue color products, C - Richer color gamut of Hue white and color ambiance products, other - Color gamut of non-hue products. |
|
X
|
data.color.xy.x | float |
X position in color gamut. |
|
Y
|
data.color.xy.y | float |
Y position in color gamut. |
|
Mirek
|
data.color_temperature.mirek | integer |
Color temperature in mirek or null when the light color is not in the ct spectrum. |
|
Mirek maximum
|
data.color_temperature.mirek_schema.mirek_maximum | integer |
Maximum color temperature this light supports. |
|
Mirek minimum
|
data.color_temperature.mirek_schema.mirek_minimum | integer |
Minimum color temperature this light supports. |
|
Mirek valid
|
data.color_temperature.mirek_valid | boolean |
Indication whether the value presented in mirek is valid. |
|
Brightness
|
data.dimming.brightness | float |
Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness. |
|
Min dim level
|
data.dimming.min_dim_level | float |
Percentage of the maximum lumen the device outputs on minimum brightness. |
|
Speed
|
data.dynamics.speed | float |
Speed of dynamic palette or effect. The speed is valid for the dynamic palette if the status is dynamic_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid. |
|
Speed valid
|
data.dynamics.speed_valid | boolean |
Indicates whether the value presented in speed is valid. |
|
Status
|
data.dynamics.status | string |
Current status of the lamp with dynamics. |
|
Status values
|
data.dynamics.status_values | array of string |
Statuses in which a lamp could be when playing dynamics. |
|
Resource id
|
data.id | string |
Unique identifier representing a specific resource instance. |
|
Clip v1 resource id
|
data.id_v1 | string |
Clip v1 resource identifier (v1 API version). |
|
Archetype
|
data.metadata.archetype | string |
Light archetype. Deprecated: use archetype on device level. |
|
Device given name
|
data.metadata.name | string |
Human readable name of a resource. |
|
Mode
|
data.mode | string |
One of: normal or streaming. |
|
Light state
|
data.on.on | boolean |
On/Off state of the light: on=true, off=false. |
|
RID
|
data.owner.rid | string |
The unique id of the referenced resource. |
|
Rtype
|
data.owner.rtype | string |
The type of the referenced resource. |
|
Type
|
data.type | string |
Type of the supported resources. |
Get lights
Get list of your devices having lightning capabilities.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
|
data
|
data | array of object |
User lights. |
|
Action values
|
data.alert.action_values | array of string |
List of alert effects that the light supports. |
|
Blue X
|
data.color.gamut.blue.x | float |
X position in color gamut. |
|
Blue Y
|
data.color.gamut.blue.y | float |
Y position in color gamut. |
|
Green X
|
data.color.gamut.green.x | float |
X position in color gamut. |
|
Green Y
|
data.color.gamut.green.y | float |
X position in color gamut. |
|
Red X
|
data.color.gamut.red.x | float |
X position in color gamut. |
|
Red Y
|
data.color.gamut.red.y | float |
X position in color gamut. |
|
Gamut type
|
data.color.gamut_type | string |
The gamut types supported by hue: A - Gamut of early Philips color-only products, B - Limited gamut of first Hue color products, C - Richer color gamut of Hue white and color ambiance products, other - Color gamut of non-hue products. |
|
X
|
data.color.xy.x | float |
X position in color gamut. |
|
Y
|
data.color.xy.y | float |
Y position in color gamut. |
|
Mirek
|
data.color_temperature.mirek | integer |
Color temperature in mirek or null when the light color is not in the ct spectrum. |
|
Mirek maximum
|
data.color_temperature.mirek_schema.mirek_maximum | integer |
Maximum color temperature this light supports. |
|
Mirek minimum
|
data.color_temperature.mirek_schema.mirek_minimum | integer |
Minimum color temperature this light supports. |
|
Mirek valid
|
data.color_temperature.mirek_valid | boolean |
Indication whether the value presented in mirek is valid. |
|
Brightness
|
data.dimming.brightness | float |
Brightness percentage. value cannot be 0, writing 0 changes it to lowest possible brightness. |
|
Min dim level
|
data.dimming.min_dim_level | float |
Percentage of the maximum lumen the device outputs on minimum brightness. |
|
Speed
|
data.dynamics.speed | float |
Speed of dynamic palette or effect. The speed is valid for the dynamic palette if the status is dynamic_palette or for the corresponding effect listed in status. In case of status none, the speed is not valid. |
|
Speed valid
|
data.dynamics.speed_valid | boolean |
Indicates whether the value presented in speed is valid. |
|
Status
|
data.dynamics.status | string |
Current status of the lamp with dynamics. |
|
Status values
|
data.dynamics.status_values | array of string |
Statuses in which a lamp could be when playing dynamics. |
|
Resource id
|
data.id | string |
Unique identifier representing a specific resource instance. |
|
Clip v1 resource id
|
data.id_v1 | string |
Clip v1 resource identifier (v1 API version). |
|
Archetype
|
data.metadata.archetype | string |
Light archetype. Deprecated: use archetype on device level. |
|
Device given name
|
data.metadata.name | string |
Human readable name of a resource. |
|
Mode
|
data.mode | string |
One of: normal or streaming. |
|
Light state
|
data.on.on | boolean |
On/Off state of the light: on=true, off=false. |
|
RID
|
data.owner.rid | string |
The unique id of the referenced resource. |
|
Rtype
|
data.owner.rtype | string |
The type of the referenced resource. |
|
Type
|
data.type | string |
Type of the supported resources. |
Get rooms
Get list of rooms (groups).
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
|
data
|
data | array of object |
Data. |
|
Children
|
data.children | array of object |
Devices to group by the Room. Following children are allowed: "device". |
|
rid
|
data.children.rid | string |
The unique id of the created scene. |
|
rtype
|
data.children.rtype | string |
The type of the created scene. |
|
Grouped services
|
data.grouped_services | array of object |
References to aggregated control services. Deprecated: use services. |
|
rid
|
data.grouped_services.rid | string |
The unique id of the created scene. |
|
rtype
|
data.grouped_services.rtype | string |
The type of the created scene. |
|
Id
|
data.id | string |
Unique identifier representing a specific resource instance. |
|
Id v1
|
data.id_v1 | string |
Clip v1 resource identifier (to be used in API v1). |
|
Archetype
|
data.metadata.archetype | string |
Default archetype given by manufacturer. |
|
Name
|
data.metadata.name | string |
Human readable name of a resource. |
|
Services
|
data.services | array of object |
References all services aggregating control and state of children in the group. Aggregation is per service type, i.e. every service type which can be grouped has a corresponding definition of grouped type. Supported types: "light". |
|
rid
|
data.services.rid | string |
The unique id of the created scene. |
|
rtype
|
data.services.rtype | string |
The type of the created scene. |
|
Type
|
data.type | string |
Type of the supported resources. |
Get scene
Get details of a specific scene.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Scene Id
|
SceneId | True | string |
Id of a scene to display details. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
|
data
|
data | array of object |
Data. |
|
Actions
|
data.actions | array of object |
List of actions executed in scene. |
|
X
|
data.actions.action.color.xy.x | float |
Minimum: 0 - maximum: 1. X position in color gamut. |
|
Y
|
data.actions.action.color.xy.y | float |
Minimum: 0 - maximum: 1. Y position in color gamut. |
|
Brightness
|
data.actions.action.dimming.brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
On
|
data.actions.action.on.on | boolean |
On/Off state of the light on=true, off=false. |
|
Mirek
|
data.actions.action.color_temperature.mirek | integer |
Minimum: 153 - maximum: 500. Color temperature in mirek or null when the light color is not in the ct spectrum. |
|
rid
|
data.actions.target.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.actions.target.rtype | string |
The type of the referenced resource. |
|
rid
|
data.group.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.group.rtype | string |
The type of the referenced resource. |
|
Id
|
data.id | string |
Unique identifier representing a specific resource instance. |
|
Id v1
|
data.id_v1 | string |
Clip v1 resource identifier (to be used in API v1). |
|
rid
|
data.metadata.image.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.metadata.image.rtype | string |
The type of the referenced resource. |
|
Name
|
data.metadata.name | string |
Human readable name of a resource. |
|
Color
|
data.palette.color | array of object | |
|
X
|
data.palette.color.color.xy.x | float |
Minimum: 0 - maximum: 1. X position in color gamut. |
|
Y
|
data.palette.color.color.xy.y | float |
Minimum: 0 - maximum: 1. Y position in color gamut. |
|
Brightness
|
data.palette.color.dimming.brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
Color temperature
|
data.palette.color_temperature | array of object | |
|
Mirek
|
data.palette.color_temperature.color_temperature.mirek | integer |
Minimum: 153 - maximum: 500. Color temperature in mirek or null when the light color is not in the ct spectrum. |
|
Brightness
|
data.palette.color_temperature.dimming.brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
Dimming
|
data.palette.dimming | array of object | |
|
Brightness
|
data.palette.dimming.brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
Speed
|
data.speed | float |
Speed of dynamic palette for this scene. |
|
Type
|
data.type | string |
Type of the supported resources. |
Get scenes
Get a list of all scenes. Scenes are used to store and recall settings for a group of lights.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
errors
|
errors | array of object |
Errors that occurred during the call. |
|
Error description
|
errors.description | string |
A human-readable explanation specific to this occurrence of the problem. |
|
data
|
data | array of object |
Data. |
|
Actions
|
data.actions | array of object |
List of actions executed in scene. |
|
X
|
data.actions.action.color.xy.x | float |
Minimum: 0 - maximum: 1. X position in color gamut. |
|
Y
|
data.actions.action.color.xy.y | float |
Minimum: 0 - maximum: 1. Y position in color gamut. |
|
Brightness
|
data.actions.action.dimming.brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
On
|
data.actions.action.on.on | boolean |
On/Off state of the light on=true, off=false. |
|
Mirek
|
data.actions.action.color_temperature.mirek | integer |
Minimum: 153 - maximum: 500. Color temperature in mirek or null when the light color is not in the ct spectrum. |
|
rid
|
data.actions.target.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.actions.target.rtype | string |
The type of the referenced resource. |
|
rid
|
data.group.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.group.rtype | string |
The type of the referenced resource. |
|
Id
|
data.id | string |
Unique identifier representing a specific resource instance. |
|
Id v1
|
data.id_v1 | string |
Clip v1 resource identifier (to be used in API v1). |
|
rid
|
data.metadata.image.rid | string |
The unique id of the referenced resource. |
|
rtype
|
data.metadata.image.rtype | string |
The type of the referenced resource. |
|
Name
|
data.metadata.name | string |
Human readable name of a resource. |
|
Color
|
data.palette.color | array of object | |
|
X
|
data.palette.color.color.xy.x | float |
Minimum: 0 - maximum: 1. X position in color gamut. |
|
Y
|
data.palette.color.color.xy.y | float |
Minimum: 0 - maximum: 1. Y position in color gamut. |
|
Brightness
|
data.palette.color.dimming.brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
Color temperature
|
data.palette.color_temperature | array of object | |
|
Mirek
|
data.palette.color_temperature.color_temperature.mirek | integer |
Minimum: 153 - maximum: 500. Color temperature in mirek or null when the light color is not in the ct spectrum. |
|
Brightness
|
data.palette.color_temperature.dimming.brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
Dimming
|
data.palette.dimming | array of object | |
|
Brightness
|
data.palette.dimming.brightness | float |
Maximum: 100. Brightness percentage. Writing 0 changes it to lowest possible brightness. |
|
Speed
|
data.speed | float |
Speed of dynamic palette for this scene. |
|
Type
|
data.type | string |
Type of the supported resources. |