Home Assistant

Home Assistant integration (Productivity). Imported from open-connector.

API key8 tools{base_url}

GET

home_assistant_get_config

Fetch the Home Assistant instance configuration.

/api/config

GET

home_assistant_list_states

List all current Home Assistant entity states.

/api/states

GET

home_assistant_get_state

Fetch the current state for one Home Assistant entity.

/api/states/{entityId}

1 parameter

Param	Type	Required	Description
entityId	string	required	The Home Assistant entity identifier, for example light.living_room.

GET

home_assistant_list_services

List Home Assistant service domains and their available services.

/api/services

POST

home_assistant_call_service

Call a Home Assistant service to control entities, such as light.turn_on or switch.turn_off.

/api/services/{domain}/{service}

4 parameters

Param	Type	Required	Description
domain	string	required	The Home Assistant service domain, for example light or switch.
service	string	required	The Home Assistant service name, for example turn_on or turn_off.
serviceData	object	optional	The JSON service data sent directly to Home Assistant, such as entity_id or bri…
returnResponse	boolean	optional	Whether to request service response data with the return_response query paramet…

GET

home_assistant_list_events

List Home Assistant event types currently known by the instance.

/api/events

POST

home_assistant_fire_event

Fire one Home Assistant event with optional event data.

/api/events/{eventType}

2 parameters

Param	Type	Required	Description
eventType	string	required	The Home Assistant event type to fire.
eventData	object	optional	The optional JSON event data sent to Home Assistant.

POST

home_assistant_render_template

Render a Home Assistant template against the connected instance.

/api/template

2 parameters

Param	Type	Required	Description
template	string	required	The Home Assistant template string to render.
variables	object	optional	Optional template variables passed to Home Assistant.