Home Assistant - Apps Documentation

Requirements

Before you set up the credential, make sure you have an active Home Assistant account and an API access token from your account settings ready.[3]

Get your Home Assistant credentials

Base URLurlRequired
The root URL of your instance, for example https://homeassistant.local:8123. Include any path prefix. Trailing slashes are fine.
[1]
Long-Lived Access TokenpasswordRequired
A long-lived access token from your profile. Treat it like a password.
[1]

Connect Home Assistant in WEXTL

Log in to your WEXTL account, add the Home Assistant node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Home Assistant account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Home Assistant node modules

The list below is a reference of every Home Assistant node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Each Home Assistant node module below opens to reveal its input parameters, outputs, and connection requirements.

Get API StatusSearch

Output fields[3]

Field	Type
Message	text

Get Calendar EventsSearch

Input fields[3]

Field	Type
CalendarRequired	choice
StartRequired	date
EndRequired	date
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Get Camera ImageSearch

Input fields[3]

Field	Type
Camera entityRequired	choice
Width	number
Height	number

Output fields[3]

Field	Type
Image	text

Get ConfigurationSearch

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Get Entity StateSearch

Input fields[3]

Field	Type
EntityRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Get Error LogSearch

Output fields[3]

Field	Type
Log	text

Get Logbook EntriesSearch

Input fields[3]

Field	Type
Start time	date
End time	date
Period (days)	number
Entities	choice
Context ID	text
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Get State HistorySearch

Input fields[3]

Field	Type
EntitiesRequired	choice
Start time	date
End time	date
Include insignificant changes	boolean
Minimal response	boolean
Omit attributes	boolean
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

List CalendarsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

List ComponentsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Component	text

List Event TypesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

List ServicesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

List StatesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Call ServiceAction

Input fields[3]

Field	Type
DomainRequired	choice
Service data	text
Return response	boolean

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Delete EntityAction

Input fields[3]

Field	Type
EntityRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Fire EventAction

Input fields[3]

Field	Type
Event typeRequired	choice
Event data	text

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Handle IntentAction

Input fields[3]

Field	Type
Intent nameRequired	text
Data	text
Language	text
Assistant	text
Device ID	text
Satellite ID	text

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Render TemplateAction

Input fields[3]

Field	Type
TemplateRequired	text
Variables	text

Output fields[3]

Field	Type
Rendered	text

Set Entity StateAction

Input fields[3]

Field	Type
EntityRequired	choice
StateRequired	text
Attributes	text
Force update	boolean

Output fields[3]

Field	Type
ID	text
Name	text
Status	text
Created at	date
Updated at	date
Data	text

Validate ConfigurationAction

Output fields[3]

Field	Type
Result	text
Errors	text
Warnings	text

Templates

Look for Home Assistant templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Other category →

References

WEXTL® Home Assistant Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Home Assistant.
WEXTL® visual workflow builder data.

Last updated: Sep 3, 2026 08:03

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.