overseerr/docs/using-overseerr/notifications/README.md

# Notifications

## Supported Notification Agents

Overseerr currently supports the following notification agents:

- [Email](./email.md)
- [Web Push](./webpush.md)
- [Discord](./discord.md)
- [Gotify](./gotify.md)
- [LunaSea](./lunasea.md)
- [Pushbullet](./pushbullet.md)
- [Pushover](./pushover.md)
- [Slack](./slack.md)
- [Telegram](./telegram.md)
- [Webhooks](./webhooks.md)

## Setting Up Notifications

Simply configure your desired notification agents in **Settings &rarr; Notifications**.

Users can customize their personal notification preferences in their own user notification settings.

## Requesting New Notification Agents

If we do not currently support your preferred notification agent, feel free to [submit a feature request on GitHub](https://github.com/sct/overseerr/issues). However, please be sure to search first and confirm that there is not already an existing request for the agent!
docs: notification agent docs added 3 years ago			`# Notifications`

docs: add email & Discord notification info (#1251) * docs: add email & Discord notification info * docs: update TOC 3 years ago			`## Supported Notification Agents`
docs: notification agent docs added 3 years ago
docs: preliminary user management documentation (#1310) [skip ci] * docs: preliminary user management documentation * docs: fix heading * docs: add quota info * docs: remove mention of image caching (for now) * docs: update FAQ to link to Users page 3 years ago			`Overseerr currently supports the following notification agents:`

docs: add email & Discord notification info (#1251) * docs: add email & Discord notification info * docs: update TOC 3 years ago			`- [Email](./email.md)`
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables 3 years ago			`- [Web Push](./webpush.md)`
docs: add email & Discord notification info (#1251) * docs: add email & Discord notification info * docs: update TOC 3 years ago			`- [Discord](./discord.md)`
feat(notif): add Gotify agent (#2196) * feat(notifications): adds gotify notifications adds new settings screen for gotify notifications including url, token and types settings fix #2183 * feat(notif): add Gotify agent addresses PR comments, runs i18n:extract fix #2183 * reword validationTokenRequired change wording to indicate presence, not validity Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com> * feat(notifications): gotify notifications fix applies changes from #2077 in which Yup validation was failing for types fix #2183 * feat(notifications): adds gotify notifications adds new settings screen for gotify notifications including url, token and types settings fix #2183 * feat(notif): add Gotify agent addresses PR comments, runs i18n:extract fix #2183 * reword validationTokenRequired change wording to indicate presence, not validity Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com> * feat(notifications): gotify notifications fix applies changes from #2077 in which Yup validation was failing for types fix #2183 * feat(notifications): incorporate issue feature into gotify notifications * feat(notifications): adds gotify notifications adds new settings screen for gotify notifications including url, token and types settings fix #2183 * feat(notif): add Gotify agent addresses PR comments, runs i18n:extract fix #2183 * reword validationTokenRequired change wording to indicate presence, not validity Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com> * feat: add missing ts field include notifyAdmin in test notification endpoint * feat: apply formatting/line break items add addition line break before conditional, change ordering of notifyAdmin/notifyUser in test endpoint * feat: remove duplicated endpoints during rebase, notification endpoints were duplicated upon rebasing. remove duplicate routes * feat: correct linting quirks * feat: formatting improvements * feat(gotify): refactor axios post to leverage 'getNotificationPayload' Co-authored-by: TheCatLady <52870424+TheCatLady@users.noreply.github.com> 2 years ago			`- [Gotify](./gotify.md)`
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables 3 years ago			`- [LunaSea](./lunasea.md)`
docs: add Pushbullet, Pushover, Slack, Telegram (#1268) [skip ci] * docs: add Pushbullet, Pushover, Telegram * docs: correction based on feedback from @costaht * docs: add Slack * docs: update Telegram docs to reflect changes in #1172 * docs: clarify PGP key format * docs: edit Pushover documentation 3 years ago			`- [Pushbullet](./pushbullet.md)`
			`- [Pushover](./pushover.md)`
			`- [Slack](./slack.md)`
			`- [Telegram](./telegram.md)`
docs: notification agent docs added 3 years ago			`- [Webhooks](./webhooks.md)`

fix(ui): Capitalization, punctuation, and grammar inconsistences & errors (#731) 3 years ago			`## Setting Up Notifications`
docs: notification agent docs added 3 years ago
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables 3 years ago			`Simply configure your desired notification agents in Settings → Notifications.`
docs: notification agent docs added 3 years ago
docs: update documentation to reflect recent changes/additions (#1730) [skip ci] * docs: update documentation to reflect recent changes/additions * docs: add list of third-party integrations * docs: add v3 warning * docs: fix Docker for Windows link text * docs: fix Telegram 'Send Silently' setting description * docs: note that application URL is required for password reset/generation * docs: add additional details on webhook template variables 3 years ago			`Users can customize their personal notification preferences in their own user notification settings.`
docs: notification agent docs added 3 years ago
docs: Various edits, and addition of UI style guide (#982) [skip ci] 3 years ago			`## Requesting New Notification Agents`
docs: notification agent docs added 3 years ago
docs: preliminary user management documentation (#1310) [skip ci] * docs: preliminary user management documentation * docs: fix heading * docs: add quota info * docs: remove mention of image caching (for now) * docs: update FAQ to link to Users page 3 years ago			`If we do not currently support your preferred notification agent, feel free to [submit a feature request on GitHub](https://github.com/sct/overseerr/issues). However, please be sure to search first and confirm that there is not already an existing request for the agent!`