Jabber (XMPP)
The xmpp
notification integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to deliver notifications from Home Assistant to a Jabber (XMPP)
Configuration
To enable Jabber notifications in your installation, add the following to your configuration.yaml
The 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.yaml
The 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.
Configuration Variables
Setting the optional parameter name
allows multiple notifiers to be created. The default value is notify
. The notifier will bind to the notify.NOTIFIER_NAME
action.
The Jabber ID (JID) that will act as origin of the messages. Add your JID including the domain, e.g., your_name@jabber.org.
Resource part of JID, e.g., your_name@jabber.org/HA-cabin
.
home-assistant
Allow disabling SSL certificate validity check, e.g., self-signed certificate.
Room’s name (e.g., example@conference.jabber.org). If set, send a message to chatroom instead of the recipient.
Pre Home Assistant 0.81 sleekxmpp
was used to connect to XMPP servers. sleekxmpp
as of version 1.3.2, does not support > TLS v1. If you are running your own XMPP server (e.g., Prosody, ejabberd) make sure to allow using TLS v1.
Home Assistant after 0.81 uses slixmpp
, which also supports TLS v1.1 and TLS v1.2.
All Jabber IDs (JID) must include the domain. Make sure that the password matches the account provided as sender.
You can send text messages and images as well as other files through Jabber.
Jabber text message
Here are some examples on how to set up a script, that can be run from an automation.
Number 1 shows a classical, text-only message. The Title is optional, although if omitted,
Home-Assistant
will be set. To keep it empty set it to ""
.
Jabber image message
You can send images or files from locally stored files or remote web locations via Jabber’s HTTP Upload feature.
To send files and images, your jabber server must support XEP_0363
Be aware that images are uploaded onto the Jabber server of your provider. They reside there un-encrypted and could be accessed by the server admins. Usually images are deleted after a few days.
Home Assistant supports TLS encryption to ensure transport encryption. TLS is enforced by default. You can disable it with the tls
flag – which is not recommended.
Number 2 sends only an image, retrieved from the URL. The TLS connection to get the image is also not verified (use with caution).
Number 3 sends an image from a local path.
Jabber file message
Number 4 sends a text-file, retrieved from GitHub, renamed to Hass_Cheatsheet.txt
to be viewable on a mobile Android device, as most don’t offer any application to view .md
files. Optionally you can add a timeout for the HTTP upload in seconds.
Templating
Number 5 sends an image retrieved from a URL, and an additional text message with title
and message
.
Number 6 sends an image from a templated URL.
The possible source of a file is prioritized and only one will be picked up. url_template
has the highest priority; next is url
then path_template
and finally if none of them are defined path
would be used. path
will be used to eliminate file extension guessing for unknown URL downloads. Only the file extension will be left, as Home Assistant changes the filename to a random string for added privacy.
To find out more about notifications, please see the getting started with automation page.