Skip to content

suedeapple/SA.Automate.Pushover

Repository files navigation

SA.Automate.Pushover

Downloads NuGet GitHub license

A Pushover connection type and action for Umbraco Automate. Send Push notifications to Pushover as part of an automation workflow.

What is Pushover?

Pushover.net is a simple notification service that lets apps send real-time alerts to mobile and desktop devices.

What can this be used for?

This package is useful when you want instant operational alerts from Umbraco Automate workflows, for example:

  • Umbraco Commerce new orders: play a "kerching" sound on your mobile device when a new order is placed.
  • Backoffice moderation tasks: use a distinct alert sound on your mobile device when content is submitted for approval.
  • General team notifications: route different events to different users or groups with different sounds and priorities.

Installation

dotnet add package SA.Automate.Pushover

No further setup required. The composer registers itself automatically via Umbraco's IComposer discovery.

Setup

1. Generate a Pushover access token and get your user/group key

In your Pushover account go to Your Applications → Create an API Token. Copy the access token.

Your User Key is shown on your Pushover dashboard. If you want to notify a group instead, create a group and use its Group Key instead.

2. Add the token and user key to appsettings (optional but recommended)

Instead of pasting the values directly into the connection, you can reference values from appsettings.json (or an environment variable, Key Vault, etc.) using Umbraco Automate's configuration references:

{
  "Umbraco": {
    "Automate": {
      "Secrets": {
        "PushoverApiToken": "your-access-token-here",
        "PushoverUserKey": "your-user-or-group-key-here"
      }
    }
  }
}

The connection's API Token and User/Group Key fields default to:

$Umbraco:Automate:Secrets:PushoverApiToken
$Umbraco:Automate:Secrets:PushoverUserKey

So adding the corresponding entries to appsettings.json is all that's needed to have them resolved automatically — no need to paste secrets into the backoffice.

3. Create the connection in the backoffice

  1. Go to Automate → Connections and create a new Pushover connection.
  2. Give the connection a name.
  3. Enter your API Token and User Key or Group Key (or leave the defaults to resolve them from appsettings, as above).
  4. Optionally set Retry and Expire — these apply to Max priority (emergency) notifications, which Pushover retries at the given interval (seconds) until acknowledged or until the expiry (seconds) is reached. Defaults are 60 and 1800.
  5. Click Test connection to verify.

Tip: You can create multiple connections, with different API Tokens, User Keys, or Group Keys, to send notifications to different Pushover applications, users, or groups.

Usage

Add the Send Pushover Notification action to any automation and select your Pushover connection. Available fields:

Field Description
Title The notification title. Supports ${ binding } expressions.
Message The notification message. Supports ${ binding } expressions.
Sound The sound to play when the notification is received, selected from a dropdown. https://pushover.net/api#sounds
Custom Sound Overrides Sound with a custom sound name uploaded to your Pushover account, if provided. Supports ${ binding } expressions.
URL Optional URL appended to the notification. Supports ${ binding } expressions.
URL Title Optional title for the URL. Supports ${ binding } expressions.
Priority The priority of the notification: Min, Low, Default, High, or Max. Defaults to Default.

Compatibility

Package version Umbraco Automate Umbraco CMS
1.x 17.x – 18.x 17.x – 18.x

Links

About

Use this with Umbraco.Automate so you can send push notifications with Pushover

Topics

Resources

License

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Sponsor this project

Packages

 
 
 

Contributors

Languages