home-assistant.io/source/_integrations/rocketchat.markdown

title, description, ha_category, ha_iot_class, ha_release, ha_domain, ha_platforms, ha_integration_type, related

title	description	ha_category	ha_iot_class	ha_release	ha_domain	ha_platforms	ha_integration_type	related
Rocket.Chat	Instructions on how to add Rocket.Chat notifications to Home Assistant.	Notifications	Cloud Push	0.56	rocketchat	notify	integration	docs title /docs/configuration/ Configuration file

The rocketchat notify {% term integration %} 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 {% term "configuration.yaml" %} file. {% include integrations/restart_ha_after_config_inclusion.md %}

# 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 notify.NOTIFIER_NAME action.
• 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:
  - action: 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.