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-09 04:29:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/rocketchat.markdown
Thomas Lovén 52eda4fda1
Replace "docs" with "documentation" (#12284) 
* Replace "docs" with "documentation"

* Blacklist docs in Textlint, use documentation instead

* Fix more occurances

Co-authored-by: Franck Nijhof <git@frenck.dev>
2020-03-10 16:17:06 +01:00

1.6 KiB
Raw Blame History

title, description, ha_category, ha_release, ha_domain
title description ha_category ha_release ha_domain
Rocket.Chat Instructions on how to add Rocket.Chat notifications to Home Assistant.
Notifications
0.56 rocketchat

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

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.

Script example

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

Message variables

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

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