| - Year + ${category['category']} | ||
|---|---|---|
| YYYY | -Numeric, four digits | -E.g. 1999, 2003 | -
| YY | -Numeric, two digits | -E.g. 99, 03 | -
| - Month - | -||
|---|---|---|
| MMMM | -Textual, full | -January-December | -
| MMM | -Textual, three letters | -Jan-Dec | -
| MM | -Numeric, with leading zeros | -01-12 | -
| M | -Numeric, without leading zeros | -1-12 | -
| - Day of the Year - | -||
|---|---|---|
| DDDD | -Numeric, with leading zeros | -001-365 | -
| DDD | -Numeric, without leading zeros | -1-365 | -
| - Day of the Month - | -||
|---|---|---|
| DD | -Numeric, with leading zeros | -01-31 | -
| D | -Numeric, without leading zeros | -1-31 | -
| Do | -Numeric, with suffix | -E.g. 1st, 2nd ... 31st. | -
| - Day of the Week - | -||
|---|---|---|
| dddd | -Textual, full | -Sunday-Saturday | -
| ddd | -Textual, three letters | -Sun-Sat | -
| d | -Numeric | -0-6 | -
| - Hour - | -||
|---|---|---|
| HH | -24-hour, with leading zeros | -00-23 | -
| H | -24-hour, without leading zeros | -0-23 | -
| hh | -12-hour, with leading zeros | -01-12 | -
| h | -12-hour, without leading zeros | -1-12 | -
| - Minute - | -||
|---|---|---|
| mm | -Numeric, with leading zeros | -00-59 | -
| m | -Numeric, without leading zeros | -0-59 | -
| - Second - | -||
|---|---|---|
| ss | -Numeric, with leading zeros | -00-59 | -
| s | -Numeric, without leading zeros | -0-59 | -
| - AM / PM - | -||
|---|---|---|
| A | -AM/PM uppercase | -AM, PM | -
| a | -am/pm lowercase | -am, pm | -
| - Timezone - | -||
|---|---|---|
| ZZ | -UTC offset | -E.g. +0100, -0700 | -
| Z | -UTC offset | -E.g. +01:00, -07:00 | -
| - Timestamp - | -|||||
|---|---|---|---|---|---|
| X | -Unix timestamp | -E.g. 1456887825 | +${parameter['value']} | +${parameter['description']} | +${parameter['example']} |
If the value for a selected parameter cannot be provided, it will display as blank.
+ % for category in common.NOTIFICATION_PARAMETERS:| - Global + ${category['category']} | |
|---|---|
| {plexpy_version} | -The current version of PlexPy. | -
| {plexpy_branch} | -The current git branch of PlexPy. | -
| {plexpy_commit} | -The current git commit hash of PlexPy. | -
| {server_name} | -The name of your Plex Server. | -
| {server_uptime} | -The uptime (in days, hours, mins, secs) of your Plex Server. | -
| {server_version} | -The current version of your Plex Server. | -
| {action} | -The action that triggered the notification. | -
| {datestamp} | -The date (in date format) the notification was triggered. | -
| {timestamp} | -The time (in time format) the notification was triggered. | -
| - Stream Details - | -|
|---|---|
| {streams} | -The number of concurrent streams. | -
| {user_streams} | -The number of concurrent streams by the person streaming. | -
| {user} | -The friendly name of the person streaming. | -
| {username} | -The username of the person streaming. | -
| {device} | -The type of client device being used for playback. | -
| {platform} | -The type of client platform being used for playback. | -
| {product} | -The type of client product being used for playback. | -
| {player} | -The name of the player being used for playback. | -
| {ip_address} | -The IP address of the device being used for playback. | -
| {stream_duration} | -The duration (in minutes) for the stream. | -
| {stream_time} | -The duration (in time format) of the stream. | -
| {remaining_duration} | -The remaining duration (in minutes) of the stream. | -
| {remaining_time} | -The remaining duration (in time format) of the stream. | -
| {progress_duration} | -The last reported offset (in minutes) of the stream. | -
| {progress_time} | -The last reported offset (in time format) of the stream. | -
| {progress_percent} | -The last reported progress percent of the stream. | -
| {transcode_decision} | -The transcode decisions of the stream. | -
| {video_decision} | -The video transcode decisions of the stream. | -
| {audio_decision} | -The audio transcode decisions of the stream. | -
| {subtitle_decision} | -The subtitle transcode decisions of the stream. | -
| {quality_profile} | -The Plex quality profile of the stream. (e.g. Original, 4 Mbps 720p, etc.) | -
| {optimized_version} | -If the stream is an optimized version. (0 or 1) | -
| {optimized_version_profile} | -The optimized version profile of the stream. | -
| {stream_local} | -If the stream is local. (0 or 1) | -
| {stream_location} | -The network location of the stream. (lan or wan) | -
| {stream_bandwidth} | -
- The required bandwidth (in kbps) of the stream.
- (not the used bandwidth) - |
-
| {stream_container} | -The media container of the stream. | -
| {stream_bitrate} | -The bitrate (in kbps) of the stream. | -
| {stream_aspect_ratio} | -The aspect ratio of the stream. | -
| {stream_video_codec} | -The video codec of the stream. | -
| {stream_video_codec_level} | -The video codec level of the stream. | -
| {stream_video_bitrate} | -The video bitrate (in kbps) of the stream. | -
| {stream_video_bit_depth} | -The video bit depth of the stream. | -
| {stream_video_framerate} | -The video framerate of the stream. | -
| {stream_video_ref_frames} | -The video reference frames of the stream. | -
| {stream_video_resolution} | -The video resolution of the stream. | -
| {stream_video_height} | -The video height of the stream. | -
| {stream_video_width} | -The video width of the stream. | -
| {stream_video_language} | -The video language of the stream. | -
| {stream_video_language_code} | -The video language code of the stream. | -
| {stream_audio_bitrate} | -The audio bitrate of the stream. | -
| {stream_audio_bitrate_mode} | -The audio bitrate mode of the stream. (cbr or vbr) | -
| {stream_audio_codec} | -The audio codec of the stream. | -
| {stream_audio_channels} | -The audio channels of the stream. | -
| {stream_audio_channel_layout} | -The audio channel layout of the stream. | -
| {stream_audio_sample_rate} | -The audio sample rate (in Hz) of the stream. | -
| {stream_audio_language} | -The audio language of the stream. | -
| {stream_audio_language_code} | -The audio language code of the stream. | -
| {stream_subtitle_codec} | -The subtitle codec of the stream. | -
| {stream_subtitle_container} | -The subtitle container of the stream. | -
| {stream_subtitle_format} | -The subtitle format of the stream. | -
| {stream_subtitle_forced} | -If the subtitles are forced. (0 or 1) | -
| {stream_subtitle_language} | -The subtitle language of the stream. | -
| {stream_subtitle_language_code} | -The subtitle language code of the stream. | -
| {stream_subtitle_location} | -The subtitle location of the stream. | -
| {transcode_container} | -The media container of the transcoded stream. | -
| {transcode_video_codec} | -The video codec of the transcoded stream. | -
| {transcode_video_width} | -The video width of the transcoded stream. | -
| {transcode_video_height} | -The video height of the transcoded stream. | -
| {transcode_audio_codec} | -The audio codec of the transcoded stream. | -
| {transcode_audio_channels} | -The audio channels of the transcoded stream. | -
| {transcode_hardware} | -If hardware transcoding is used. (0 or 1) | -
| {session_key} | -The unique identifier for the session. | -
| {transcode_key} | -The unique identifier for the transcode session. | -
| {session_id} | -The unique identifier for the stream. | -
| {user_id} | -The unique identifier for the user. | -
| {machine_id} | -The unique identifier for the player. | -
| - Source Metadata Details - | -|
|---|---|
| {media_type} | -The type of media. (movie, show, season, episode, artist, album, track) | -
| {title} | -The full title of the item. | -
| {library_name} | -The library name of the item. | -
| {show_name} | -The title of the TV series. | -
| {episode_name} | -The title of the episode. | -
| {artist_name} | -The name of the artist. | -
| {album_name} | -The title of the album. | -
| {track_name} | -The title of the track. | -
| {season_num} | -The season number. (e.g. 1, or 1-3) | -
| {season_num00} | -The two digit season number. (e.g. 01, or 01-03) | -
| {episode_num} | -The episode number. (e.g. 6, or 6-10) | -
| {episode_num00} | -The two digit episode number. (e.g. 06, or 06-10) | -
| {track_num} | -The track number. (e.g. 4, or 4-10) | -
| {track_num00} | -The two digit track number. (e.g. 04, or 04-10) | -
| {year} | -The release year for the item. | -
| {release_date} | -The release date (in date format) for the item. | -
| {air_date} | -The air date (in date format) for the item. | -
| {added_date} | -The date (in date format) the item was added to Plex. | -
| {updated_date} | -The date (in date format) the item was updated on Plex. | -
| {last_viewed_date} | -The date (in date format) the item was last viewed on Plex. | -
| {studio} | -The studio for the item. | -
| {content_rating} | -The content rating for the item. (e.g. TV-MA, TV-PG, etc.) | -
| {directors} | -A list of directors for the item. | -
| {writers} | -A list of writers for the item. | -
| {actors} | -A list of actors for the item. | -
| {genres} | -A list of genres for the item. | -
| {summary} | -A short plot summary for the item. | -
| {tagline} | -A tagline for the media item. | -
| {rating} | -The rating (out of 10) for the item. | -
| {audience_rating} | -
- The audience rating (%) for the item.
- (Ratings source must be Rotten Tomatoes for the Plex Movie agent) - |
-
| {duration} | -The duration (in minutes) for the item. | -
| {poster_url} | -A URL for the movie, TV show, or album poster. | -
| {plex_url} | -The Plex URL to your server for the item. | -
| {imdb_id} | -
- The IMDB ID for the movie. (e.g. tt2488496)
- (PMS agent must be Plex Movie) - |
-
| {imdb_url} | -
- The IMDB URL for the movie.
- (PMS agent must be Plex Movie) - |
-
| {thetvdb_id} | -
- The TVDB ID for the TV show. (e.g. 121361)
- (PMS agent must be TheTVDB) - |
-
| {thetvdb_url} | -
- The TVDB URL for the TV show.
- (PMS agent must be TheTVDB) - |
-
| {themoviedb_id} | -
- The TMDb ID for the movie or TV show. (e.g. 15260)
- (PMS agent must be The Movie Database) - |
-
| {themoviedb_url} | -
- The TMDb URL for the movie or TV show.
- (PMS agent must be The Movie Database) - |
-
| {lastfm_url} | -
- The Last.fm URL for the album.
- (PMS agent must be Last.fm) - |
-
| {trakt_url} | -The trakt.tv URL for the movie or TV show. | -
| {container} | -The media container of the original media. | -
| {bitrate} | -The bitrate of the original media. | -
| {aspect_ratio} | -The aspect ratio of the original media. | -
| {video_codec} | -The video codec of the original media. | -
| {video_codec_level} | -The video codec level of the original media. | -
| {video_bitrate} | -The video bitrate of the original media. | -
| {video_bit_depth} | -The video bit depth of the original media. | -
| {video_framerate} | -The video framerate of the original media. | -
| {video_ref_frames} | -The video reference frames of the original media. | -
| {video_resolution} | -The video resolution of the original media. | -
| {video_height} | -The video height of the original media. | -
| {video_width} | -The video width of the original media. | -
| {video_language} | -The video language of the original media. | -
| {video_language_code} | -The video language code of the original media. | -
| {audio_bitrate} | -The audio bitrate of the original media. | -
| {audio_bitrate_mode} | -The audio bitrate mode of the original media. (cbr or vbr) | -
| {audio_codec} | -The audio codec of the original media. | -
| {audio_channels} | -The audio channels of the original media. | -
| {audio_channel_layout} | -The audio channel layout of the original media. | -
| {audio_language} | -The audio language of the original media. | -
| {audio_language_code} | -The audio language code of the original media. | -
| {subtitle_codec} | -The subtitle codec of the original media. | -
| {subtitle_container} | -The subtitle container of the original media. | -
| {subtitle_format} | -The subtitle format of the original media. | -
| {subtitle_forced} | -If the subtitles are forced. (0 or 1) | -
| {subtitle_location} | -The subtitle location of the original media. | -
| {subtitle_language} | -The subtitle language of the original media. | -
| {subtitle_language_code} | -The subtitle language code of the original media. | -
| {file} | -The file path to the item. | -
| {file_size} | -The file size of the item. | -
| {section_id} | -The unique identifier for the library. | -
| {rating_key} | -The unique identifier for the movie, episode, or track. | -
| {parent_rating_key} | -The unique identifier for the season or album. | -
| {grandparent_rating_key} | -The unique identifier for the TV show or artist. | -
| {thumb} | -The Plex thumbnail for the movie or episode. | -
| {parent_thumb} | -The Plex thumbnail for the season or album. | -
| {grandparent_thumb} | -The Plex thumbnail for the TV show or artist. | -
| {poster_thumb} | -The Plex thumbnail for the poster image. | -
| - Plex Update Available - | -|
|---|---|
| {update_version} | -The available update version for your Plex Server. | -
| {update_url} | -The download URL for the available update. | -
| {update_release_date} | -The release date of the available update. | -
| {update_channel} | -The update channel. (Public or Plex Pass) | -
| {update_platform} | -The platform of your Plex Server. | -
| {update_distro} | -The distro of your Plex Server. | -
| {update_distro_build} | -The distro build of your Plex Server. | -
| {update_requirements} | -The requirements for the available update. | -
| {update_extra_info} | -Any extra info for the available update. | -
| {update_changelog_added} | -The added changelog for the available update. | -
| {update_changelog_fixed} | -The fixed changelog for the available update. | -
| - PlexPy Update Available - | -|||
|---|---|---|---|
| {plexpy_update_version} | -The available update version for PlexPy. | -||
| {plexpy_update_tar} | -The tar download URL for the available update. | -||
| {plexpy_update_zip} | -The zip download URL for the available update. | -||
| {plexpy_update_commit} | -The commit hash for the available update. | -||
| {plexpy_update_behind} | -The number of commits behind for the available update. | -||
| {plexpy_update_changelog} | -The changelog for the available update. | +{${parameter['value']}} | +
+ ${parameter['description']}
+ % if parameter['example']:
+ (${parameter['example']})
+ % endif
+ % if parameter['help_text']:
+ (${parameter['help_text']}) + % endif + |