Marius/JBOPS
1
0
Fork 0
mirror of https://github.com/blacktwin/JBOPS.git synced 2025-12-16 21:15:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update rich notification section

Browse Source
This commit is contained in:
Blacktwin 2018-09-26 09:09:16 -04:00
parent 467ae80e02
commit 6fff1c61df
1 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
killstream/readme.md
View File

@ -168,6 +168,15 @@ Arguments:
### Rich Notifications (Discord or Slack) ### Rich Notifications (Discord or Slack)
The following can be added to any of the above examples. The following can be added to any of the above examples.
**How it Works:**
Tautulli > Script Agent > Script > Tautulli > Webhook Agent > Discord/Slack
1. Tautulli's script agent is executed
1. Script executes
1. The script sends the json data to the webhook agent
1. Webhook agent passes the information to Discord/Slack
**Limitations:** **Limitations:**
* Due to [size](https://api.slack.com/docs/message-attachments#thumb_url) limitations by slack. A thumbnail may not appear with every notification when using `--posterUrl {poster_url}`. * Due to [size](https://api.slack.com/docs/message-attachments#thumb_url) limitations by slack. A thumbnail may not appear with every notification when using `--posterUrl {poster_url}`.
* `allStreams` will not have poster images in the notifications. * `allStreams` will not have poster images in the notifications.
@ -178,17 +187,28 @@ The following can be added to any of the above examples.
or or
`--richMessage slack` `--richMessage slack`
**_Note: The notifier must be a Webhook in Tautulli_** **_Note: The notifierID must be a Webhook in Tautulli_**
**Optional:** **Optional:**
```
```log
--serverName {server_name} --plexUrl {plex_url} --posterUrl {poster_url} --richColor '#E5A00D' --serverName {server_name} --plexUrl {plex_url} --posterUrl {poster_url} --richColor '#E5A00D'
``` ```
**Debug:**
Add `--debug` to enable debug logging. **Webhook Setup:**
1. Settings -> Notification Agents -> Add a new notification agent -> Webhook
1. For the **Webhook URL** enter your slack or discord webhook URL. </br>
Some examples:
* Discord: [Intro to Webhooks](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
* Slack: [Incoming Webhooks](https://api.slack.com/incoming-webhooks)
1. **Webhook Method** - `POST`
1. No triggers or any other configuration is needed. The script will pass the notifier the data to send to Discord/Slack.
<p> <p>
<img width="420" src="https://i.imgur.com/9iQZsq4.png"> <img width="420" src="https://i.imgur.com/9iQZsq4.png">
<img width="420" src="https://i.imgur.com/VvivqCX.png"> <img width="420" src="https://i.imgur.com/VvivqCX.png">
</p> </p>
### Debug
Add `--debug` to enable debug logging.