2024.11.3
Home ▸ Integrations ▸

Rocket.Chat

The rocketchat notify integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# 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.

Related topics