Mirrored_Repos/JBOPS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/master'

Browse Source
This commit is contained in:
Blacktwin 2018-10-07 09:20:44 -04:00
commit 19e85e6dbb
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
killstream/readme.md
View File

@ -168,39 +168,38 @@ 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:** #### How it Works
Tautulli > Script Agent > Script > Tautulli > Webhook Agent > Discord/Slack Tautulli > Script Agent > Script > Tautulli > Webhook Agent > Discord/Slack
1. Tautulli's script agent is executed 1. Tautulli's script agent is executed
1. Script executes 1. Script executes
1. The script sends the json data to the webhook agent 1. The script sends the JSON data to the webhook agent
1. Webhook agent passes the information to Discord/Slack 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.
**Required:** #### Required arguments
`--notify notifierID --richMessage discord` * Discord: `--notify notifierID --richMessage discord`
or * Slack: `--notify notifierID --richMessage slack`
`--richMessage slack`
**_Note: The notifierID must be a Webhook in Tautulli_** **_Note: The notifierID must be a Webhook in Tautulli_**
**Optional:** #### Optional arguments
```log ```log
--serverName {server_name} --plexUrl {plex_url} --posterUrl {poster_url} --richColor '#E5A00D' --serverName {server_name} --plexUrl {plex_url} --posterUrl {poster_url} --richColor '#E5A00D'
``` ```
**Webhook Setup:** #### Webhook Setup
1. Settings -> Notification Agents -> Add a new notification agent -> Webhook 1. Settings -> Notification Agents -> Add a new notification agent -> Webhook
1. For the **Webhook URL** enter your slack or discord webhook URL. </br> 1. For the **Webhook URL** enter your Slack or Discord webhook URL. </br>
Some examples: Some examples:
* Discord: [Intro to Webhooks](https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks) * 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) * Slack: [Incoming Webhooks](https://api.slack.com/incoming-webhooks)
1. **Webhook Method** - `POST` 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. 1. No triggers or any other configuration is needed. The script will pass the notifier the data to send to Discord/Slack.