File tree 2 files changed +56
-0
lines changed 2 files changed +56
-0
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ layout : page
3
+ title : " Rocket.Chat"
4
+ description : " Instructions on how to add Rocket.Chat notifications to Home Assistant."
5
+ date : 2017-09-23 20:00
6
+ sidebar : true
7
+ comments : false
8
+ sharing : true
9
+ footer : true
10
+ logo : rocketchat.png
11
+ ha_category : Notifications
12
+ ha_release : 0.56
13
+ ---
14
+
15
+
16
+ The ` rocketchat ` platform allows you to send messages to your [ Rocket.Chat] ( https://rocket.chat/ ) instance from Home Assistant.
17
+
18
+ To add Rocket.Chat to your installation, add the following to your ` configuration.yaml ` file:
19
+
20
+ ``` yaml
21
+ # Example configuration.yaml entry
22
+ notify :
23
+ - platform : rocketchat
24
+ name : NOTIFIER_NAME
25
+ url : https://rocketchat.example.com
26
+ username : USERNAME
27
+ password : PASSWORD
28
+ room : my-awesome-room
29
+ ` ` `
30
+
31
+ - **name** (*Optional*): Name displayed in the frontend. The notifier will bind to the service ` notify.NOTIFIER_NAME`.
32
+ - **url** (*Required*): The URL of your Rocket.Chat instance.
33
+ - **username** (*Required*): The Rocket.Chat username.
34
+ - **password** (*Required*): The Rocker.Chat password.
35
+ - **room** (*Required*): The chat room name to send messages to.
36
+
37
+ # ## {% linkable_title script.yaml example %}
38
+
39
+ ` ` ` yaml
40
+ rocketchat_notification:
41
+ sequence:
42
+ - service: notify.NOTIFIER_NAME
43
+ data:
44
+ message: "Message to Rocket.Chat from Home Assistant!"
45
+ data:
46
+ emoji: ":smirk:"
47
+ ` ` `
48
+
49
+ # ### {% linkable_title Message variables %}
50
+
51
+ - **message** (*Required*): Message to be displayed.
52
+ - **data** (*Optional*): Dictionary containing any of the variables defined in the
53
+ [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example)
54
+
55
+ To use notifications, please see the [getting started with automation page](/getting-started/automation/).
56
+
You can’t perform that action at this time.
0 commit comments