Jabber (XMPP)


The xmpp notification platform allows you to deliver notifications from Home Assistant to a Jabber (XMPP) account.

Configuration

To enable Jabber notifications in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: xmpp
    sender: YOUR_JID
    password: YOUR_JABBER_ACCOUNT_PASSWORD
    recipient: YOUR_RECIPIENT

Configuration Variables

name

(string)(Optional)Setting the optional parameter name allows multiple notifiers to be created. The default value is notify. The notifier will bind to the service notify.NOTIFIER_NAME.

Default value: Random Sensor

sender

(string)(Required)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

(string)(Optional)Resource part of JID, e.g., your_name@jabber.org/HA-cabin.

Default value: home-assistant

password

(Required)The password for your given Jabber account.

recipient

(Required)The Jabber ID (JID) that will receive the messages.

tls

(boolean)(Optional)Force TLS.

Default value: true

verify

(boolean)(Optional)Allow disabling SSL certificate validity check, e.g., self-signed certificate.

Default value: true

room

(string)(Optional)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.

To use notifications, please see the getting started with automation page.