Skip to main content

Home Assistant Receipe

Setup#

  1. Access your profile after logging into your Home Assistant website.
  2. You need to generate a Long-Lived Access Tokens via the Create Token button (very bottom of profile page)

Receipe#

Valid syntax is as follows:

  • hassio://{host}/{long-lived-access-token}
  • hassio://{user}:{pass}:{host}/{access_token}
  • hassio://{user}:{pass}:{host}:{port}/{access_token}
  • hassio://{host}/optional/path/{access_token}
  • hassio://{user}:{pass}:{host}/optional/path/{access_token}
  • hassio://{user}:{pass}:{host}:{port}/optional/path/{access_token}

By default hassio:// will use port 8123 (unless you otherwise specify). If you use hassios:// (adding an s) to the end, then you use the https protocol on port 443 (unless otherwise specified).

So the same URL's above could be written using a secure connection/port as:

  • hassios://{host}/{access_token}
  • hassios://{user}:{pass}:{host}/{access_token}
  • hassios://{user}:{pass}:{host}:{port}/{access_token}
  • hassios://{host}/optional/path/{access_token}
  • hassios://{user}:{pass}:{host}/optional/path/{access_token}
  • hassios://{user}:{pass}:{host}:{port}/optional/path/{access_token}

The other thing to note is that Home Assistant requires a notification_id associated with each message sent. If the ID is the same as the previous, then the previous message is over-written with the new. This may or may not be what your goal is.

So by default Magic Receipe will generate a unique ID (thus a separate message) on every call. If this isn't the effect you're going for, then define your own Notification ID like so:

  • hassio://{host}/{long-lived-access-token}?nid=myid

Parameter Breakdown#

VariableRequiredDescription
access_tokenYesThe generated Long Lived Access Token from your profile page.
hostnameYesThe Web Server's hostname
portNoThe port our Web server is listening on. By default the port is 8123 for hassios:// and 443 for all jsons:// references.
userNoIf you're system is set up to use HTTP-AUTH, you can provide username for authentication to it.
passwordNoIf you're system is set up to use HTTP-AUTH, you can provide password for authentication to it.
nidNoAllows you to specify the Notification ID used when sending the notifications to Home Assistant. By doing this, each message sent to Home Assistant will replace the last.