Skip to content

feat(webhook): add jellyfinMediaId and jellyfinUserId to webhook notification #1959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
+14 −7
Open

feat(webhook): add jellyfinMediaId and jellyfinUserId to webhook notification #1959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/using-seerr/notifications/webhook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,14 @@ The `{{media}}` will be `null` if there is no relevant media object for the noti

These following special variables are only included in media-related notifications, such as requests.

| Variable | Value |
| -------------------- | -------------------------------------------------------------------------------------------------------------- |
| `{{media_type}}` | The media type (`movie` or `tv`) |
| `{{media_tmdbid}}` | The media's TMDB ID |
| `{{media_tvdbid}}` | The media's TheTVDB ID |
| `{{media_status}}` | The media's availability status (`UNKNOWN`, `PENDING`, `PROCESSING`, `PARTIALLY_AVAILABLE`, or `AVAILABLE`) |
| `{{media_status4k}}` | The media's 4K availability status (`UNKNOWN`, `PENDING`, `PROCESSING`, `PARTIALLY_AVAILABLE`, or `AVAILABLE`) |
| Variable | Value |
| ------------------------------| -------------------------------------------------------------------------------------------------------------- |
| `{{media_type}}` | The media type (`movie` or `tv`) |
| `{{media_tmdbid}}` | The media's TMDB ID |
| `{{media_tvdbid}}` | The media's TheTVDB ID |
| `{{media_status}}` | The media's availability status (`UNKNOWN`, `PENDING`, `PROCESSING`, `PARTIALLY_AVAILABLE`, or `AVAILABLE`) |
| `{{media_status4k}}` | The media's 4K availability status (`UNKNOWN`, `PENDING`, `PROCESSING`, `PARTIALLY_AVAILABLE`, or `AVAILABLE`) |
| `{{media_jellyfinMediaId}}` | The media's Jellyfin Media ID |

#### Request

Expand All @@ -104,6 +105,7 @@ The following special variables are only included in request-related notificatio
| `{{requestedBy_username}}` | The requesting user's username |
| `{{requestedBy_email}}` | The requesting user's email address |
| `{{requestedBy_avatar}}` | The requesting user's avatar URL |
| `{{requestedBy_jellyfinUserId}}` | The requesting user's Jellyfin User ID |
| `{{requestedBy_settings_discordId}}` | The requesting user's Discord ID (if set) |
| `{{requestedBy_settings_telegramChatId}}` | The requesting user's Telegram Chat ID (if set) |

Expand Down
3 changes: 3 additions & 0 deletions server/lib/notifications/agents/webhook.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,14 @@ const KeyMap: Record<string, string | KeyMapFunction> = {
media_tmdbid: 'media.tmdbId',
media_tvdbid: 'media.tvdbId',
media_type: 'media.mediaType',
media_jellyfinMediaId: (payload) =>
payload.media?.jellyfinMediaId ?? payload.media?.jellyfinMediaId4k ?? '',
media_status: (payload) =>
payload.media ? MediaStatus[payload.media.status] : '',
media_status4k: (payload) =>
payload.media ? MediaStatus[payload.media.status4k] : '',
request_id: 'request.id',
requestedBy_jellyfinUserId: 'request.requestedBy.jellyfinUserId',
requestedBy_username: 'request.requestedBy.displayName',
requestedBy_email: 'request.requestedBy.email',
requestedBy_avatar: 'request.requestedBy.avatar',
Expand Down
2 changes: 2 additions & 0 deletions src/components/Settings/Notifications/NotificationsWebhook/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ const defaultPayload = {
media_type: '{{media_type}}',
tmdbId: '{{media_tmdbid}}',
tvdbId: '{{media_tvdbid}}',
jellyfinMediaId: '{{media_jellyfinMediaId}}',
status: '{{media_status}}',
status4k: '{{media_status4k}}',
},
Expand All @@ -42,6 +43,7 @@ const defaultPayload = {
requestedBy_email: '{{requestedBy_email}}',
requestedBy_username: '{{requestedBy_username}}',
requestedBy_avatar: '{{requestedBy_avatar}}',
requestedBy_jellyfinUserId: '{{requestedBy_jellyfinUserId}}',
requestedBy_settings_discordId: '{{requestedBy_settings_discordId}}',
requestedBy_settings_telegramChatId:
'{{requestedBy_settings_telegramChatId}}',
Expand Down