github/plexpy
1
0
Fork 0
mirror of https://github.com/Tautulli/Tautulli.git synced 2024-11-20 20:40:25 -08:00
Code Issues Packages Projects Releases Wiki Activity
Page: Notification Agents Guide
Pages
3rd Party APIs Guide Asking for Support Custom Notification Conditions Custom Scripts Debugging Exporter Guide Frequently Asked Questions Home Install as a daemon Installation Notification Agents Guide Tautulli API Reference Upgrading to Python 3 (Tautulli v2.5)
53 Notification Agents Guide
JonnyWong16 edited this page 2024-09-22 07:54:46 -07:00
Table of Contents

Notification Agents:

Browser

  1. Click on Allow Notifications and give permission for Tautulli to send notifications through your browser.

Boxcar

  1. Go to the Settings page in your Boxcar app.
  2. Copy the Access Token and fill in the Tautulli setting.

Discord

  1. Go to Discord, and click on Edit Channel for the channel where you want the notifications to be sent.
  2. Go to the Webhooks tab and click on Create Webhook.
  3. Give your webhook bot a Name and Icon. This can be changed in the Tautulli settings instead if you wish.
  4. Copy the Webhook URL and fill in the Tautulli setting.

Email

  • Note: Some anti-virus software have "Email protection" which may prevent sending emails via SMTP from a script. This will either need to be disabled or add an exception for Tautulli to send emails.

Gmail

SMTP Server:     smtp.gmail.com
SMTP Port:       587 or 465
SMTP User:       YourEmail@gmail.com or Username
SMTP Password:   Your Google app password
Encryption:      TLS/STARTTLS (587) or SSL/TLS (465)

Outlook.com

SMTP Server:     smtp.office365.com
SMTP Port:       587
SMTP User:       YourEmail@outlook.com
SMTP Password:   Your Outlook app password
Encryption:      TLS/STARTTLS (587)

Facebook

Facebook has blocked all non-approved applications from posting to a group programmatically. Although Tautulli shouldn't be against their terms, they are refusing to approve any app that can do this.

There only currently known workaround is that Zapier also allows posting to Facebook, see their agent guide for how to set this up. See here for an example Facebook configuration within Zapier.

Old, non-working instructions

This script by @spuniun could be used to post directly, however, Facebook has started banning accounts using it so it has been removed from the recommended methods. See the Custom Scripts page for help setting it up.

Note: Facebook has redone their app approval process, as such all apps must go through the approval process fully before they will work again. To work around this you can send notifications via email to the group's secret email address from an account that is in the group.

Note: As of March 2018, all new Facebook apps require HTTPS for authorization. If Tautulli is not running with HTTPS, the easiest method would be to check "Enable HTTPS" under the Web Interface tab (show advanced). This can be disabled after authorizing with Facebook.

  1. Go to Facebook Developers and click Add a New App.
  2. Click Add Product on the left, then click Set Up for Facebook Login.
  3. Skip the Quickstart and go to Facebook Login > Settings on the left, and fill in the Valid OAuth redirect URIs with the one provided by Tautulli.
  4. Go to Settings > Basic on the left, and fill in a Privacy Policy URL.
  5. On the same page, get your App ID and App Secret and fill in the respective Tautulli settings.
  6. Go to App Review on the left, and toggle your app to toggle "Make Public" to Yes.
  7. Click the Request Authorization button in Tautulli to allow it to access your Facebook account. Make sure the app visibility is set to Public or Friends (Only Me will not work).
  8. Copy the Access Token and fill in the Tautulli setting if it is not filled in automatically.
  9. Get your Group ID from the URL of your group page (e.g. https://www.facebook.com/groups/<GROUP_ID>) and fill in the Tautulli setting. If you have customized the URL and no longer have easy access to the Group ID, see this answer for how to obtain it. Note: You should only put the ID in the setting for Tautulli, not the full URL.

Gotify

  1. Go to your Gotify server and click Apps at the top.
  2. Click Create Application.
  3. Give your application a Name and click Create.
  4. Copy the App Token and fill in the Tautulli setting.

GroupMe

  1. Go to GroupMe Developers and click Access Token at the top. Copy the token and fill in the Tautulli setting.
  2. Go to the Bots tab at the top and click Create Bot.
  3. Select the group chat where you want the notifications to be sent, give your bot a Name and Avatar, and click Submit. All other fields can be left at their default values.
  4. Copy the Bot ID and fill in the Tautulli setting.

Growl

  1. Open Growl and go to the General tab to make sure Growl is turned On and running.
  2. Optional: Go to the Security tab to set up a Password. Check "Allow network notifications" if Growl is running on a separate machine than Tautulli.
  3. Fill in the Host for the machine running Growl (e.g. localhost or 192.168.0.100) in the Tautulli settings.
  4. Fill in the Password, if required, in the Tautulli settings.

Hipchat

  1. Go to Hipchat Integrations, select the room where you want the notifications to be sent, and click Build your own integration.
  2. Give your integration a Name and click Create.
  3. Copy the Integration URL and fill in the Tautulli setting.

IFTTT

  1. Go to IFTTT and set up your Webhooks service.
  2. Click on Documentation to get your Webhook Key and fill in the Tautulli setting.
  3. Create a New Applet, with "this" as "Webhooks", and the trigger "Receive a web request".
  4. Fill in the Event Name with the one that matches the Tautulli setting.
    • Tip: You can create different IFTTT events (e.g. tautulli_play, tautulli_stop, tautulli_created, etc.) by adding {action} to the Event Name in Tautulli (e.g. tautulli_{action}).
  5. Select "that" as whichever service you want.
  6. Fill in the settings of your service by adding the ingredients Value1, Value2, and Value3.
    • Value1 will be the subject line in your notification text settings.
    • Value2 will be the body text in your notification text settings.
    • (Optional) Value3 can be anything you select (e.g. Poster URL).

Join

  1. Go to Join App, and click on Join API, then Show.
  2. Copy the API Key and fill in the Tautulli setting.

Kodi

  1. From within Kodi, go to Settings > Service settings > Control, and make sure "Allow remote control via HTTP" is checked.
  2. Optional: Set the Port, Username, and Password for the Kodi Webserver. The default port is 8080.
  3. Enter in the Host Address for the machine running Kodi (e.g. http://localhost:8080) in the Tautulli settings.
  4. Fill in the Username and Password, if required, in the Tautulli settings.

macOS Notification Center

Note: macOS Notification Center notifications will only work on the machine where Tautulli is installed.

  1. Fill in the path to your Tautulli application. The default is /Applications/Tautulli.
  2. Click the Register App button to register Tautulli with the Notification Center.

Microsoft Teams

  1. In the channel where you want the notifications to be sent, click the overflow menu (...), select Connectors, and add a new Incoming Webhook connector.
  2. Configure a new incoming webhook, give it a name and image, and click Create.
  3. Copy the Webhook URL and fill in the Tautulli setting.

MQTT

  1. Fill in the settings from your MQTT broker.

Notify My Android

  1. Go to Notify My Android and click Generate New Key.
  2. Copy the API Key and fill in the Tautulli setting.

Plex Home Theater

Note: Plex Home Theater notifications only work with OpenPHT or RasPlex.

  1. From within OpenPHT/RasPlex, go to Preferences > System > Services, and make sure "Allow remote control via HTTP" is checked.
  2. Enter in the Host Address for the machine running OpenPHT or RasPlex with the port 3005 (e.g. http://localhost:3005).
  3. Fill in the Username and Password, if required, in the Tautulli settings.

Plex Android / iOS App

Note: Plex Pass is required to send notifications to the Plex mobile apps.

  1. Open the Plex Android or iOS app, go to Settings > Notifications and enable the following notifications matching the triggers in the Tautulli notification agent:
    1. New Content Added to Library - Tautulli trigger: Recently Added
      • Note: Make sure to uncheck all libraries for the server connected to Tautulli.
    2. Playback Started - Tautulli trigger: Playback Start
      • Note: Make sure to uncheck the server and all users connected to Tautulli.
    3. New Devices - Tautulli trigger: User New Device
      • Note: Make sure to uncheck the server connected to Tautulli.
  2. Send a Test Notification from Tautulli and you should receive one test notification for each notification you have enabled in the Plex App.

Note: The user(s) receiving the notifications must have notifications enabled for the matching Tautulli triggers in their Plex mobile app.

Note: The user(s) must uncheck all the servers, libraries, and users connected to Tautulli in the Plex mobile app settings otherwise they may receive duplicate notifications from Plex and Tautulli. Use the custom notification agent conditions in Tautulli to filter the notifications instead.

Note: Push notifications do not need to be enabled in your Plex server Settings > General page. However, you may leave it enabled to receive the other notifications types from Plex (new server shared with you, new item on deck, database corruption detected, database backed up, etc.).

Prowl

  1. Go to Prowl, and generate a new API key by clicking Generate Key.
  2. Copy the API Key and fill in the Tautulli Setting.

Pushbullet

  1. Go to Pushbullet Account Settings, and click Create Access Token.
  2. Copy the Access Token and fill in the Tautulli Setting.

Pushover

  1. Go to Pushover, and Create a New Application.
  2. Give your application a Name and Icon, and click Create Application.
  3. Copy the API Token and fill in the Tautulli Setting.
  4. Go back to the Pushover homepage.
    • If you want to send notifications to yourself, copy your User Key and fill in the Tautulli setting.
    • If you want to send notifications to a group, go to Create a New Group. Copy the Group Key and fill in the Tautulli setting.

Script

Slack

  1. Go to Slack, and create a new Incoming Webhook.
  2. Select the slack channel where you want the notifications to be sent, and click Add Incoming Webhooks integration.
  3. Copy your Webhook URL and fill in the Tautulli setting.
  4. Scroll down to Integration Settings, and give your integration a Name and Icon. This can be changed in the Tautulli settings instead if you wish.

Tautulli Remote Android App

Telegram

  1. Message @BotFather on Telegram with the command /newbot to create a new bot.
  2. Follow the instructions to give your bot a display name and a bot username.
  3. Copy the Bot Token and fill in the Tautulli setting.

Sending Messages to Yourself

  1. Create a new chat with your bot.
  2. Message @myidbot on Telegram with the command /getid to get your Chat ID.
  3. Copy the Chat ID and fill in the Tautulli setting.

Sending Messages to a Group

  1. Create a new group chat with your bot in the group and @myidbot.
  2. Message @myidbot in the group with the command /getgroupid to get your Group ID.
  3. Copy the Group ID and fill in the Tautulli setting. Don't forget the hyphen (-) in the Group ID.
    • For a group topic, append /topicID to the group ID (e.g. -1000000000000/2).

Sending Messages to a Channel

Public Channel

  1. Create a new Public Channel in Telegram.
  2. Fill in the Public Link to your channel. This is your channel username (e.g. t.me/<CHANNEL_USERNAME>).
  3. Go to Manage Channel and add your bot to the Administrators.
  4. Copy the Channel Username and fill in the Tautulli setting. Don't forget the @ sign (@<CHANNEL_USERNAME>) in the Channel Username.

Private Channel

  1. Create a new Private Channel in Telegram.
  2. Go to Manage Channel and add your bot and @myidbot to the Administrators.
  3. Message @myidbot in the channel with the command /getgroupid to get your Channel ID.
  4. Copy the Channel ID and fill in the Tautulli setting. Don't forget the hyphen (-) in the Channel ID.

Twitter

  1. Go to Twitter Apps and click Create New App.
  2. Give your app a Name, Description, and Website. A valid website is not required.
  3. Go to the "Keys and Access Tokens" tab to get your Consumer Key and Consumer Secret, and fill in the respective Tautulli settings.
  4. Click on Create my access token to get your Access Token and Access Token Secret, and fill in the respective Tautulli settings.

Webhook

  1. Find the Webhook URL for the service you are going to be using and fill in the Tautulli setting. Some examples:
  2. Pick the appropriate HTTP request method for your Webhook Method. Generally, you want to select POST here.
  3. Customize the raw JSON Data sent to the webhook on the Data tab.
JSON Data Examples:

Zapier

  1. Go to Zapier and Make a Zap.
  2. For "When this happens...", Choose App as "Webhooks by Zapier", and Choose Trigger as "Catch Hook", then click Continue.
  3. Copy the Custom Webhook URL and fill in the Tautulli setting, then click Continue in Zapier.
  4. Click Test & Review in Zapier, then click the Send Test Data button in Tautulli. A new hook will show up in Zapier with test data from Tautulli. Once everything is okay, click Done Editing.
  5. For "Do this...", Choose App as whichever service you want, and follow the instructions to connect the service.
  6. Set Up Template using the values Body, Subject, Action, Provider Name, Provider Link, Plex URL, and Poster URL. These values will all be filled in by Tatutulli.
  7. Make sure your Zap is turned on in the top right.