https://github.com/joshooaj/pspushover
Send push notifications anywhere for any reason using the Pushover.net service
https://github.com/joshooaj/pspushover
notifications push-notifications pushover
Last synced: 4 months ago
JSON representation
Send push notifications anywhere for any reason using the Pushover.net service
- Host: GitHub
- URL: https://github.com/joshooaj/pspushover
- Owner: joshooaj
- License: mit
- Created: 2024-03-19T15:14:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T19:34:15.000Z (about 1 year ago)
- Last Synced: 2025-10-31T04:38:55.162Z (8 months ago)
- Topics: notifications, push-notifications, pushover
- Language: PowerShell
- Homepage: http://www.joshooaj.com/PSPushover/
- Size: 4.44 MB
- Stars: 46
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: docs/README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# PSPushover
[](https://squidfunk.github.io/mkdocs-material/)
The PSPushover PowerShell module makes it a breeze to send push notifications to any device using the
[Pushover](https://pushover.net) service from PowerShell on Windows, Linux, and MacOS. You can send push notifications to Android, iOS, and
desktop devices.
Each notification is associated with an "application", and can be sent to an individual user, or
to a group of users. Get notified...
- when backups fail
- when cron jobs run
- when servers restart
- when your GitHub Actions / Azure DevOps / Jenkins / GitLab pipelines fail
- [when someone star's your GitHub repo](https://github.com/joshooaj/PSPushover/blob/main/.github/workflows/NotifyOnStarred.yml)
- __whenever and for whatever you want!__
## :material-star-shooting: Try it out
When this GitHub repository receives a new star, it triggers a GitHub Action [workflow](https://github.com/joshooaj/PSPushover/blob/main/.github/workflows/NotifyOnStarred.yml) which uses PSPushover to send a notification to anyone who subscribes using the link below.
[Subscribe to Star Notifications](https://pushover.net/subscribe/PSPushover-2hw5raj6uqr5dsw)
Pushover will generate a random user token for you and add it to a distribution group. You can unsubscribe from your Pushover dashboard at any time, and your real user token is never exposed. So go ahead and try it out! If you already had the repo starred before subscribing, you can unstar and star it again as many times as you like.
## :fontawesome-solid-person-walking-arrow-right: Getting started
All Pushover notifications are sent from an __application__ to a __user__ or __group__. To send
your first push notification, you need an __application token__ and a __user key__. To receive
notifications, you need the Pushover app installed on a mobile device, or at least have the website
open with notifications enabled in a [compatible browser](https://pushover.net/clients/desktop).
### Create an application
Notifications need to come from _something_, and with Pushover, that something is an "application".
The application can be named anything you like. Naming things is hard though, so if you can't
decide on a name, use "PSPushover".
1. Register and/or login at [pushover.net](https://pushover.net/login).
2. Take note of your __user key__. It looks like `ygzttgcfpab5wyrtstnxlrqllpr0et`.
3. Under __Your Applications__, click __Create an Application/API Token__, fill out the required
fields, and take note of the api key.
### Install PSPushover
```powershell
Install-Module joshooaj.PSPushover -Scope CurrentUser -Repository PSGallery
```
### Set default tokens
You can choose to enter your app and user tokens each time you call `Send-Pushover`, but you
can also save them securely using `Set-PushoverConfig` and then they'll become the default values
when no alternate tokens are provided.
```powershell
$appToken = Read-Host -Prompt 'Application token' -AsSecureString
$usrToken = Read-Host -Prompt 'User token' -AsSecureString
Set-PushoverConfig -Token $appToken -User $usrToken
```
### Send a message
It's time to send your first push notification!
```powershell
Send-Pushover -Message 'Hello from PSPushover!'
```