From 980c34b7aab6f90c72555723b3e88f369086ad8b Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sat, 7 Aug 2021 18:01:49 -0400 Subject: [PATCH] Updated Notify_rocketchat (markdown) --- Notify_rocketchat.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/Notify_rocketchat.md b/Notify_rocketchat.md index fac8a74..4116e16 100644 --- a/Notify_rocketchat.md +++ b/Notify_rocketchat.md @@ -12,15 +12,17 @@ Rocket.Chat can send notifications through the following **modes**: Secure connections (via https) should be referenced using **rockets://** where as insecure connections (via http) should be referenced via **rocket://**. #### Basic Mode -Valid syntaxes are as follows: -* **rocket**://**{user}**:**{password}**@**{hostname}**/#**{channel}** -* **rocket**://**{user}**:**{password}**@**{hostname}**:**{port}**/#**{channel}** -* **rocket**://**{user}**:**{password}**@**{hostname}**/**{room_id}** -* **rocket**://**{user}**:**{password}**@**{hostname}**:**{port}**/**{room_id}** -* **rockets**://**{user}**:**{password}**@**{hostname}**/#**{channel}** -* **rockets**://**{user}**:**{password}**@**{hostname}**:**{port}**/#**{channel}** -* **rockets**://**{user}**:**{password}**@**{hostname}**/**{room_id}** -* **rockets**://**{user}**:**{password}**@**{hostname}**:**{port}**/**{room_id}** +Valid syntax is as follows: +* `rocket://{user}:{password}@{hostname}/#{channel}` +* `rocket://{user}:{password}@{hostname}:{port}/#{channel}` +* `rocket://{user}:{password}@{hostname}/{room_id}` +* `rocket://{user}:{password}@{hostname}:{port}/{room_id}` +* `rockets://{user}:{password}@{hostname}/#{channel}` +* `rockets://{user}:{password}@{hostname}:{port}/#{channel}` +* `rockets://{user}:{password}@{hostname}/{room_id}` +* `rockets://{user}:{password}@{hostname}:{port}/{room_id}` + +**Note:** the `?avatar=yes` option will only work if your user has the `bot` permission setting. You can also form any combination of the above and perform updates from one url: * **rocket**://**{user}**:**{password}**@**{hostname}**/#**{channel_id}**/**{room_id}** @@ -28,14 +30,14 @@ You can also form any combination of the above and perform updates from one url: For the Basic Mode Only: if neither a **{room_id}** or **#{channel}** is specified then this notification will fail. #### Webhook Mode -Valid syntaxes are as follows: -* **rocket**://**{webhook}**@**{hostname}**/#**{channel}** -* **rocket**://**{webhook}**@**{hostname}**/**{room_id}** -* **rocket**://**{webhook}**@**{hostname}**/**{@user}** -* **rockets**://**{webhook}**@**{hostname}**/#**{channel}** -* **rockets**://**{webhook}**@**{hostname}**:**{port}**/#**{channel}** -* **rockets**://**{webhook}**@**{hostname}**/**{room_id}** -* **rockets**://**{webhook}**@**{hostname}**:**{port}**/**{room_id}** +Valid syntax is as follows: +* `rocket://{webhook}@{hostname}/#{channel}` +* `rocket://{webhook}@{hostname}/{room_id}` +* `rocket://{webhook}@{hostname}/{@user}` +* `rockets://{webhook}@{hostname}/#{channel}` +* `rockets://{webhook}@{hostname}:{port}/#{channel}` +* `rockets://{webhook}@{hostname}/{room_id}` +* `rockets://{webhook}@{hostname}:{port}/{room_id}` You can also form any combination of the above and perform updates from one url: * **rocket**://**{webhook}**@**{hostname}**:**{port}**/#**{channel_id}**/**{room_id}**/**@{user}** @@ -56,7 +58,7 @@ By default a webhook is set up to be associated with a channel. Thus the follow | channel | No | Channels must be prefixed with a hash (#) or they will be interpreted as a room_id. Available for both **basic** and **webhook** modes. Channels must be registered with your Rocket.Chat server to work. | user_id | No | Another user you wish to notify. User IDs must be prefixed with an at symbol (@). Available for the **webhook** mode only. | mode | No | The authentication mode is automatically detected based what it parses from the URL provided. You only need to set this if you feel it is being detected incorrectly. The possible modes are **basic** and **webhook** and are explained above. -| avatar | No | Override the default avatar associated with the message to match that of the notification type (be that of a Warning, Error, Info, etc). By default this is set to **Yes**. +| avatar | No | Override the default avatar associated with the message to match that of the notification type (be that of a Warning, Error, Info, etc). By default this is set to **No** for **basic** mode and **Yes** for **webhook** mode. #### Example Send a Rocket.Chat notification to the channel *#nuxref*: