Adding upstream version 0.8.9.

Signed-off-by: Daniel Baumann <daniel@debian.org>
2025-05-22 10:16:14 +02:00 · 2025-05-22 10:16:14 +02:00 · c0c4addb85
commit c0c4addb85
parent 3b2c48b5e4
285 changed files with 25880 additions and 0 deletions
--- a/docs/services/rocketchat.md
+++ b/docs/services/rocketchat.md
@ -0,0 +1,66 @@
+# Rocket.chat
+
+## URL Format
+
+!!! info ""
+    rocketchat://[__`username`__@]__`rocketchat-host`__/__`token`__[/__`channel`&#124;`@recipient`__]* 
+
+--8<-- "docs/services/rocketchat/config.md"
+
+## Creating a Webhook in Rocket.chat
+
+1. Open up the chat Administration by clicking on *Administration* menu
+![Screenshot 1](rocketchat/1.png)
+
+2. Open *Integrations* and then click *New*
+![Screenshot 2](rocketchat/2.png)
+
+3. Fill in the information for the webhook and click *Save*. Please don't forget to Enable your integration. 
+![Screenshot 3](rocketchat/3.png)
+
+5. If you did everything correctly, Rocket.chat will give you the *URL* and *Token* to your newly created webhook.
+![Screenshot 4](rocketchat/4.png)
+
+6. Format the service URL
+```
+rocketchat://your-domain.com/8eGdRzc9r4YYNyvge/2XYQcX9NBwJBKfQnphpebPcnXZcPEi32Nt4NKJfrnbhsbRfX
+                             └────────────────────────────────────────────────────────────────┘
+                                                           token
+```
+
+## Additional URL configuration
+
+Rocket.chat provides functionality to post as another user or to another channel / user, compared to the webhook configuration.
+<br/>
+To do this, you can add a *sender* and/or *channel* / *receiver* to the service URL.
+
+```
+rocketchat://shoutrrrUser@your-domain.com/8eGdRzc9r4YYNyvge/2XYQcX9NBwJBKfQnphpebPcnXZcPEi32Nt4NKJfrnbhsbRfX/shoutrrrChannel
+             └──────────┘                 └────────────────────────────────────────────────────────────────┘ └─────────────┘
+                sender                                                   token                                   channel
+
+rocketchat://shoutrrrUser@your-domain.com/8eGdRzc9r4YYNyvge/2XYQcX9NBwJBKfQnphpebPcnXZcPEi32Nt4NKJfrnbhsbRfX/@shoutrrrReceiver
+             └──────────┘                 └────────────────────────────────────────────────────────────────┘ └───────────────┘
+                sender                                                   token                                    receiver
+```
+
+## Passing parameters via code
+
+If you want to, you also have the possibility to pass parameters to the `send` function.
+<br/>
+The following example contains all parameters that are currently supported.
+
+```gotemplate
+params := (*types.Params)(
+	&map[string]string{
+		"username": "overwriteUserName",
+		"channel": "overwriteChannel",
+	},
+)
+
+service.Send("this is a message", params)
+```
+
+This will overwrite any options, that you passed via URL.
+
+For more Rocket.chat Webhooks options see [official guide](https://docs.rocket.chat/guides/administrator-guides/integrations).