Signal Messenger

The signal_messenger integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] uses the Signal Messenger REST API to deliver notifications from Home Assistant to your Android or iOS device.

Setup

The requirements are:

• You need to set up the Signal Messenger REST API.
• You need a spare phone number to register with the Signal Messenger service.

Please follow those instructions, to set up the Signal Messenger REST API.

Configuration

To send Signal Messenger notifications with Home Assistant, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry for Signal Messenger 
notify:
  - name: signal
    platform: signal_messenger
    url: "http://127.0.0.1:8080" # the URL where the Signal Messenger REST API is listening 
    number: "YOUR_PHONE_NUMBER" # the sender number
    recipients: # one or more recipients
      - "RECIPIENT1"

Both phone numbers and Signal Messenger groups can be added to the recipientslist. However, it’s not possible to mix phone numbers and Signal Messenger groups in a single notifier. If you would like to send messages to individual phone numbers and Signal Messenger groups, separate notifiers need to be created.

To obtain the Signal Messenger group ids, follow this guide.

Notification action

Examples

A few examples on how to use this integration to send notifications from automations.

Text message

...
actions:
  - action: notify.NOTIFIER_NAME
    data:
      message: "That's an example that sends a simple text message to the recipients specified in the configuration.yaml. If text mode is 'styled', you can use *italic*, **bold** or ~strikethrough~ ."
      ## Optional
      data:
        text_mode: styled

Text message with an attachment

This example assumes you have an image stored in the default www-folder in Home Assistant Operating System.

...
actions:
  - action: notify.NOTIFIER_NAME
    data:
      message: "Alarm in the living room!"
      data:
        attachments:
          - "/config/www/surveillance_camera.jpg"
        text_mode: styled

Text message with an attachment from a URL

...
actions:
  - action: notify.NOTIFIER_NAME
    data:
      message: "Person detected on Front Camera!"
      data:
        verify_ssl: false
        urls:
          - "http://homeassistant.local/api/frigate/notifications/<event-id>/thumbnail.jpg"
        text_mode: styled

Notes:

• To attach files from outside of Home Assistant, the URLs must be reachable and added to the allowlist_external_urls list.

• There is a 50MB size limit for attachments retrieved via URLs.

Sending messages to Signal to trigger events

You can use the Signal Messenger REST API as a Home Assistant trigger. In this example, we will make a simple chatbot. If you write anything to your Signal account linked to Signal Messenger REST API, the automation gets triggered, with the condition that the number (attribute source) is correct, to take action by sending a Signal notification back with a “Message received!”.

To accomplish this, make sure the addon’s mode parameter is set to native or normal, and edit the configuration of Home Assistant, adding a RESTful resource as follows:

- resource: "http://127.0.0.1:8080/v1/receive/<number>"
  headers:
    Content-Type: application/json
  sensor:
    - name: "Signal message received"
      value_template: "" #this will fetch the message
      json_attributes_path: $[0].envelope
      json_attributes:
        - source #using attributes you can get additional information, in this case, the phone number.

You can create an automation as follows:

...
triggers:
  - trigger: state
    entity_id:
      - sensor.signal_message_received
    attribute: source
    to: "<yournumber>"
actions:
  - action: notify.signal
    data:
      message: "Message received!"

NOTE If the parameter mode is set to json-rpc, then you can use signal-api-receiver to receive from Signal as follows:

- resource: "http://127.0.0.1:8105/receive/pop"
  sensor:
    - name: "Signal message received"
      value_template: >
        
      json_attributes_path: envelope
      json_attributes:
        - source
        - sourceNumber
        - sourceUuid
        - sourceDevice
        - timestamp