Skip to main content
Version: v1.5

Home Assistant

Instructions on how you can use Secured Signal API as a notification service for Home Assistant.

Setup​

1. Home Assistant Configuration​

To be able to use the Signal Messenger integration in Home Assistant you need to modify or add the following to your configuration.yml file:

notify:
  - name: signal
    platform: signal_messenger
    url: "http://sec-signal-api:8880/@auth=API_TOKEN"
    number: "{{.NUMBER}}"
    recipients:
      - "+123400002" # tip: use a placeholder instead
tip

If you want to use a recipients placeholder (array) instead of single recipients, modify the url to http://sec-signal-api/@auth=API_TOKEN/@recipients={{.RECIPIENTS}}

Here we are taking advantage of the url field for adding /@auth=API_TOKEN in order to use Path Auth.

For more detailed configuration instructions read the official Home Assistant docs.

2. Enabling Path Auth​

By default, Path Auth is disabled, so we first need to enable it in the config by adding path to auth.methods:

api:
  auth:
    methods: [bearer, basic, body, path]

And that's basically it, have fun!

Sources​