2.5 KiB
layout, title, description, date, sidebar, comments, sharing, footer
layout | title | description | date | sidebar | comments | sharing | footer |
---|---|---|---|---|---|---|---|
page | Notifications | Instructions how to add user notifications to Home Assistant. | 2015-01-20 22:36 | true | false | true | true |
The notify
component makes it possible to send notifications to a wide variety of platforms. Please check the sidebar for a full list of platforms that are supported.
{% linkable_title Configuration %}
# Example configuration.yaml entry
notify:
platform: pushbullet
# Optional name for the notify service
name: paulus
# api_key is a required config key by the pushbullet platform
api_key: ABCDEFG
The name parameter is optional but needed if you want to use multiple platforms. The platform will be exposed as service notify/<name>
. The name will default to notify
if not supplied.
{% linkable_title Service %}
Once loaded, the notify
platform will expose a service that can be called to send notifications.
Service data attribute | Optional | Description |
---|---|---|
message |
no | Body of the notification. |
title |
yes | Title of the notification. Default is Home Assistant . |
target |
yes | Some platforms will allow specifying a recipient that will receive the notification. See your platform page if it is supported. |
The notification component supports specifying templates for both the message
and the title
. This will allow you to use the current state of Home Assistant in your notifications.
In an action of your automation setup it could look like this with a customized subject.
action:
service: notify.notify
data:
message: "Your message goes here"
title: "Custom subject"
{% linkable_title Test if it works %}
A simple way to test if you have set up your notify platform correctly is to use Services from the Developer Tools. Choose your service (notify/xyz) from the list of Available services: and enter something like the sample below into the Service Data field and hit CALL SERVICE.
{
"message": "The sun is {% raw %}{% if is_state('sun.sun', 'above_horizon') %}up{% else %}down{% endif %}{% endraw %}!"
}