home-assistant.io/source/_components/persistent_notification.markdown
cdce8p 572f001f5b Added description for markdown in persistent notifications (#5124)
* Added markdown description for persistent_notification

* Minor change
2018-04-06 09:16:35 +02:00

3.1 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_release
page Persistent notification Instructions on how to integrate persistent notifications into Home Assistant. 2016-06-25 10:00 true false true true home-assistant.png Other 0.23

The persistent_notification can be used to show a message on the frontend that has to be dismissed by the user.

{% linkable_title Service %}

The service persistent_notification/create takes in message, title, and notification_id.

Service data attribute Optional Description
message no Body of the notification.
title yes Title of the notification.
notification_id yes If notification_id is given, it will overwrite the notification if there already was a notification with that ID.

The persistent_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: persistent_notification.create
  data:
    message: "Your message goes here"
    title: "Custom subject"

The service persistent_notification/dismiss requires a notification_id.

Service data attribute Optional Description
notification_id no the notification_id is required to identify the notification that should be removed.

This service allows you to remove a notifications by script or automation.

action:
  service: persistent_notification.dismiss
  data:
    notification_id: "1234"

{% linkable_title Markdown support %}

The message attribute supports the Markdown formatting syntax. Some examples are:

Type Message
Headline 1 # Headline
Headline 2 ## Headline
Newline \n
Bold **My bold text**
Cursive *My cursive text*
Link [Link](https://home-assistant.io/)
Image ![image](/local/my_image.jpg)

`/local/` in this context refers to the `.homeassistant/www/` folder.

{% linkable_title Create a persistent notification %}

Choose service developer tool icon Services from the Developer Tools to call the persistent_notification service. Select persistent_notification/create from the list of Available services: and enter something like the sample below into the Service Data field and hit CALL SERVICE.

{
  "notification_id": "1234",
  "title": "Sample notification",
  "message": "This is a sample text"
}

This will create the notification entry shown above.