jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-02 09:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/notify.xmpp.markdown
Alok Saboo 1aca7b08cf Misc fixes: e.g. -> e.g., and proper case for Home Assistant (#4942) 
* e.g. to e.g., and proper case for Home Assistant

* Instructions how to -> Instructions on how to
2018-03-17 20:20:37 +01:00

1.7 KiB
Raw Blame History

layout title description date sidebar comments sharing footer logo ha_category ha_release
page Jabber (XMPP) Instructions on how to add Jabber (XMPP) notifications to Home Assistant. 2015-05-08 18:00 true false true true xmpp.png Notifications pre 0.7

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

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 (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.
  • sender (Required): The Jabber ID (JID) that will act as origin of the messages. Add your JID including the domain, eg. your_name@jabber.org.
  • password (Required): The password for your given Jabber account.
  • recipient (Required): The Jabber ID (JID) that will receive the messages.
  • tls (Optional): Allow to disable TLS. Defaults to true.
  • verify (Optional): Allow disabling SSL certificate validity check (e.g., self-signed certificate). Defaults to true.
  • room (Optional): Room's name (e.g., example@conference.jabber.org). If set, send a message to chatroom instead of the sender.

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.