mirror of
https://github.com/jagandeepbrar/lunasea.git
synced 2026-08-31 12:42:34 +00:00
90 lines
3.8 KiB
Plaintext
90 lines
3.8 KiB
Plaintext
---
|
|
title: Tautulli Notifications
|
|
description: Setting up Tautulli for webhook-based push notifications
|
|
---
|
|
|
|
# Tautulli Notifications
|
|
|
|
## Preparation
|
|
|
|
1. Read through the main [Notifications](/lunasea/notifications) page
|
|
2. Copy your device-based or user-based webhook URL from LunaSea
|
|
|
|
## Setup the Webhook
|
|
|
|
In Tautulli's web GUI, head to Settings -> Notification Agents, hit the "Add a new notification agent" button and select "LunaSea". Please follow each section below to setup the webhook:
|
|
|
|
<Tabs
|
|
defaultValue="configuration"
|
|
values={[
|
|
{ label: "Configuration", value: "configuration" },
|
|
{ label: "Triggers", value: "triggers" },
|
|
{ label: "Conditions", value: "conditions" },
|
|
{ label: "Text", value: "text" },
|
|
]}
|
|
>
|
|
<TabItem value="configuration">
|
|
**LunaSea Webhook URL**
|
|
|
|
Paste the full device-based or user-based URL that was copied from LunaSea.
|
|
|
|
**LunaSea Profile**
|
|
|
|
Enter in the name of the profile which should be an _exact match_ to the profile that this module instance was added to within LunaSea. Capitalization and punctuation does matter.
|
|
|
|
> This step is only required if you are not using the default LunaSea profile (`default`). LunaSea will assume the default profile when none is supplied.
|
|
>
|
|
> Correctly setting up this field is critically important to get full deep-linking support.
|
|
</TabItem>
|
|
|
|
<TabItem value="triggers">
|
|
Select which events should trigger a push notification. The following triggers are supported:
|
|
|
|
| Trigger | Supported? |
|
|
| :--------------------------: | :--------: |
|
|
| Playback Start | ✅ |
|
|
| Playback Stop | ✅ |
|
|
| Playback Pause | ✅ |
|
|
| Playback Resume | ✅ |
|
|
| Playback Error | ✅ |
|
|
| Transcode Decision Change | ✅ |
|
|
| Watched | ✅ |
|
|
| Buffer Warning | ✅ |
|
|
| User Concurrent Streams | ✅ |
|
|
| User New Device | ✅ |
|
|
| Recently Added | ✅ |
|
|
| Plex Server Down | ✅ |
|
|
| Plex Server Back Up | ✅ |
|
|
| Plex Remote Access Down | ✅ |
|
|
| Plex Remote Access Back Up | ✅ |
|
|
| Plex Update Available | ✅ |
|
|
| Tautulli Update Available | ✅ |
|
|
| Tautulli Database Corruption | ✅ |
|
|
</TabItem>
|
|
|
|
<TabItem value="conditions">
|
|
You can _optionally_ add conditions that must be met for the webhook notifications to trigger.
|
|
|
|
You can set as many conditions as you like, and can combine different conditions for different triggers by adding separate webhooks to Tautulli.
|
|
</TabItem>
|
|
|
|
<TabItem value="text">
|
|
A default message is set for all trigger types, but on this page you can alter the exact text that would appear in the message.
|
|
|
|
Please read the top of this tab in Tautulli about how to utilize the different modifiers.
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
Once setup, close LunaSea and run the webhook test in Tautulli. You should receive a new notification letting you know that LunaSea is ready to receive Tautulli notifications!
|
|
|
|
## Attach Images to Notifications
|
|
|
|
This step is **optional** but recommended. Unlike other modules, in order to receive the actual images (posters, etc.) instead of a generic poster along with the notification, you will need to setup an image host within Tautulli.
|
|
|
|
1. Go to Tautulli's web GUI
|
|
2. Open the Settings, enter "3rd Party APIs"
|
|
3. Select any of the available image providers
|
|
- If selecting `Self-hosted on public domain`, ensure that the image path (`/tautulli/image`) is publicly accessible from the internet
|
|
4. Follow the [3rd Party APIs Guide](https://github.com/Tautulli/Tautulli/wiki/3rd-Party-APIs-Guide) to acquire the required details for the chosen image provider
|
|
5. Enter and save the acquired API/Client ID information
|