mirror of
https://github.com/jellyfin/jellyfin-plugin-webhook.git
synced 2024-11-27 00:00:28 +00:00
.github | ||
Jellyfin.Plugin.Webhook | ||
.gitattributes | ||
.gitignore | ||
build.yaml | ||
Jellyfin.Plugin.Webhook.sln | ||
jellyfin.ruleset | ||
LICENSE | ||
README.md |
Jellyfin TheTVDB Plugin
Part of the Jellyfin Project
Use Handlebars templating engine to format notifications however you wish.
See Templates for sample templates.
Helpers:
- if_equals
- if first parameter equals second parameter case insensitive
- if_exist
- if the value of the parameter is not null or empty
- link_to
- wrap the $url and $text in an
<a>
tag
- wrap the $url and $text in an
Variables:
-
Every Notifier
- ServerId
- ServerName
- ServerVersion
$major.$minor.$build
- ServerUrl
- Server url
- NotificationType
- The NotificationType
-
BaseItem:
- Timestamp
- Current server time local
- UtcTimestamp
- Current server time utc
- Name
- Item name
- Overview
- Item overview
- ItemId
- Item id
- ItemType
- Item type
- Year
- Item production year
- SeriesName
- TV series name
- SeasonNumber
- Series number - direct format
- SeasonNumber00
- Series number - padded 00
- SeasonNumber000
- Series number - padded 000
- EpisodeNumber
- Episode number - direct format
- EpisodeNumber00
- Episode number - padded 00
- EpisodeNumber000 -
- Episode number - padded 000
- Provider_{providerId_lowercase}
- ProviderId is lowercase.
- RunTimeTicks
- The media runtime, in Ticks
- RunTime
- The media runtime, as
hh:mm:ss
- The media runtime, as
- Timestamp
-
Playback
- Includes everything from
BaseItem
- PlaybackPositionTicks
- The current playback position, in Ticks
- PlaybackPosition
- The current playback position, as
hh:mm:ss
- The current playback position, as
- MediaSourceId
- The media source id
- IsPaused
- If playback is paused
- IsAutomated
- If notification is automated, or user triggered
- DeviceId
- Playback device id
- DeviceName
- Playback device name
- ClientName
- Playback client name
- Username
- User playing item. Note: multiple notifications will be sent if there are multiple users in a session
- UserId
- The user Id
- PlayedToCompletion
true/false
, Only whenNotificationType == PlaybackStop
- Includes everything from
Destination Specific:
- Discord
- MentionType
- EmbedColor
- AvatarUrl
- Username
- Gotify
- Priority
- Pushbullet
- Pushover
- Token
- UserToken
- Device
- Title
- MessageUrl
- MessageUrlTitle
- MessagePriority
- NotificationSound
- SMTP
Future events can be created from https://github.com/jellyfin/jellyfin/blob/master/Jellyfin.Server.Implementations/Events/EventingServiceCollectionExtensions.cs