home-assistant.io/source/_components/notify.rocketchat.markdown
Fabian Affolter 2851b2a606
Update configuration samples (#5041)
* Update configuration samples

* Minor changes
2018-03-29 10:02:47 +02:00

1.7 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 Rocket.Chat Instructions on how to add Rocket.Chat notifications to Home Assistant. 2017-09-23 20:00 true false true true rocketchat.png Notifications 0.56

The rocketchat notify platform allows you to send messages to your Rocket.Chat instance from Home Assistant.

{% linkable_title Configuration %}

To add Rocket.Chat to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
notify:
  - platform: rocketchat
    name: NOTIFIER_NAME
    url: https://rocketchat.example.com
    username: YOUR_USERNAME
    password: YOUR_PASSWORD
    room: YOUR_ROOM_NAME
  • name (Optional): Name displayed in the frontend. The notifier will bind to the service notify.NOTIFIER_NAME.
  • url (Required): The URL of your Rocket.Chat instance.
  • username (Required): The Rocket.Chat username.
  • password (Required): The Rocker.Chat password.
  • room (Required): The chat room name to send messages to.

{% linkable_title script.yaml example %}

rocketchat_notification:
  sequence:
  - service: notify.NOTIFIER_NAME
    data:
      message: "Message to Rocket.Chat from Home Assistant!"
      data:
        emoji: ":smirk:"

{% linkable_title Message variables %}

  • message (Required): Message to be displayed.
  • data (Optional): Dictionary containing any of the variables defined in the Rocket.Chat docs

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