[Enhancement]: Notification Event for general download #2448

Open
opened 2026-04-25 00:07:14 +02:00 by adam · 3 comments
Owner

Originally created by @ykelvis on GitHub (Dec 31, 2024).

Type of Enhancement

Server Backend

Describe the Feature/Enhancement

There is one notification event for auto-download.

Notification Event: onPodcastEpisodeDownloaded Triggered when a podcast episode is auto-downloaded

This can only be triggered by audiobookshelf's cron update. But a) use the api path /api/podcasts/{id}/checknew to update a podcast or b) download episode using the webui don't seem to trigger this event.

Why would this be helpful?

It would be helpful if any successful download event can trigger notification. I'm using a script to check new episodes, so the situation is like (a). Also in case of (b) if an old podcast/episode is added, it's good to notify user there's new content available.

Future Implementation (Screenshot)

N/A

Audiobookshelf Server Version

v2.17.6

Current Implementation (Screenshot)

No response

Originally created by @ykelvis on GitHub (Dec 31, 2024). ### Type of Enhancement Server Backend ### Describe the Feature/Enhancement There is one notification event for auto-download. > Notification Event: onPodcastEpisodeDownloaded Triggered when a podcast episode is auto-downloaded This can only be triggered by audiobookshelf's cron update. But a) use the [api path](https://api.audiobookshelf.org/#check-for-new-podcast-episodes) `/api/podcasts/{id}/checknew` to update a podcast or b) download episode using the webui don't seem to trigger this event. ### Why would this be helpful? It would be helpful if any successful download event can trigger notification. I'm using a script to check new episodes, so the situation is like (a). Also in case of (b) if an old podcast/episode is added, it's good to notify user there's new content available. ### Future Implementation (Screenshot) N/A ### Audiobookshelf Server Version v2.17.6 ### Current Implementation (Screenshot) _No response_
adam added the enhancement label 2026-04-25 00:07:14 +02:00
Author
Owner

@nichwall commented on GitHub (Dec 31, 2024):

Would this be a single notification that new episodes were downloaded or a notification for each episode as it is downloaded?

Like if you are downloading new episodes in the web UI, and then decide you want to download more episodes, should there be a timeout before a new notification is sent (like 5 minutes), or would we want to send the notification every time the download queue is empty?

@nichwall commented on GitHub (Dec 31, 2024): Would this be a single notification that new episodes were downloaded or a notification for each episode as it is downloaded? Like if you are downloading new episodes in the web UI, and then decide you want to download more episodes, should there be a timeout before a new notification is sent (like 5 minutes), or would we want to send the notification every time the download queue is empty?
Author
Owner

@ykelvis commented on GitHub (Jan 1, 2025):

It's a download completion event so I don't think audiobookshelf should process anything, fire a notification for every single episode sounds good.

@ykelvis commented on GitHub (Jan 1, 2025): It's a download completion event so I don't think audiobookshelf should process anything, fire a notification for every single episode sounds good.
Author
Owner

@advplyr commented on GitHub (Jan 1, 2025):

If downloading a thousand episodes at a time it could trigger a thousand notifications. I brought up the same issue with adding a notification for every new library item https://github.com/advplyr/audiobookshelf/pull/3464#issuecomment-2380894943.

That could be an issue we just pass to the user to handle. If we do that there will most likely be follow on issues opened with users triggering a thousand notifications and requesting additional support for throttling or batch notifications.

@advplyr commented on GitHub (Jan 1, 2025): If downloading a thousand episodes at a time it could trigger a thousand notifications. I brought up the same issue with adding a notification for every new library item https://github.com/advplyr/audiobookshelf/pull/3464#issuecomment-2380894943. That could be an issue we just pass to the user to handle. If we do that there will most likely be follow on issues opened with users triggering a thousand notifications and requesting additional support for throttling or batch notifications.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#2448