github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_rocketchat (markdown)

master
Chris Caron 2024-04-13 20:02:14 -04:00
parent c2fba24a2c
commit e54ffe4171
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Notify_rocketchat.md

@ -50,14 +50,14 @@ By default a webhook is set up to be associated with a channel. Thus the follow
| Variable | Required | Description
| ----------- | -------- | -----------
| user | *Yes | The user identifier you've associated with your Rocket.Chat server. This is only required if you are not providing a **webhook** instead. This can be optionally combined with the **webhook** if you wish to over-ride the bot name.
| password | *Yes | The password identifier you've associated with your Rocket.Chat server. This is only required if you are not providing a **webhook** instead
| password | *Yes | The password identifier you've associated with your Rocket.Chat server. This is only required if you are not providing a **webhook** instead. This value can also substitute for a pre-generated token as well.
| webhook | *Yes | The incoming webhook you created and associated with your Rocket.Chat server . This is only required if you are not providing a **webhook** instead
| hostname | Yes | The Rocket.Chat server you're sending your notification to.
| port | No | The port the Rocket.Chat server is listening on. By default the port is **80** for **rocket://** and **443** for all **rockets://** references.
| room_id | No | A room identifier. Available for both **basic** and **webhook** modes.
| 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.
| 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**, **token**, 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 **No** for **basic** mode and **Yes** for **webhook** mode.
#### Example