SA.Automate.Ntfy 1.0.4

SA.Automate.Ntfy

ntfy connection types and actions for Umbraco Automate. Send push notifications to ntfy as part of an automation workflow.

What is ntfy?

ntfy (pronounced "notify") is a simple HTTP-based pub-sub notification service. You publish to a topic, and anyone subscribed to that topic, via the mobile app, web app, or desktop, receives the notification. It can be used against the public ntfy.sh server or against a self-hosted instance.

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: notify a topic when a new order is placed.
• Backoffice moderation tasks: alert a topic when content is submitted for approval.
• General team notifications: route different events to different topics with different tags and priorities.

Installation

dotnet add package SA.Automate.Ntfy

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

Connection types

This package registers a single ntfy connection type, used for both public and protected topics:

• Topic: the ntfy topic to publish to.
• Server URL: optional. Overrides the globally configured server for this connection. Leave blank to use the default.
• Access Token: optional. Leave blank for public topics. If set, it's sent as an Authorization: Bearer header. Stored as a sensitive value and masked in the back office.
• Use default access token: optional toggle. If enabled and no Access Token is set above, falls back to the default access token configured in appsettings.json. Leave off for public topics, so no Authorization header is ever sent.

Setup

1. (Optional) Configure defaults

By default, connections publish to the public https://ntfy.sh server with no access token. If you self-host ntfy, or want a shared access token, set defaults in your appsettings.json (or appsettings.Production.json); individual connections can still override the server URL, and only use the default token if they explicitly enable Use default access token:

{
  "Umbraco": {
    "Automate": {
      "Providers": {
        "SA.Automate.Ntfy": {
          "ServerUrl": "https://ntfy.example.com",
          "AccessToken": "tk_..."
        }
      }
    }
  }
}

2. Create the connection in the backoffice

1. Go to Automate → Connections and create a new ntfy connection.
2. Give the connection a name and enter the Topic (and an Access Token if the topic is protected, or enable Use default access token to reuse the one configured in appsettings.json).
3. Optionally override the Server URL for this connection.
4. Click Test connection to verify. This performs a lightweight reachability check against the topic: it does not publish a visible notification, but note that it checks read access, which on strictly access-controlled self-hosted servers can differ from the write access actually needed to publish.

Tip: You can create multiple connections, with different topics, to send notifications to different channels.

Usage

Add the Send ntfy Notification action to any automation and select the connection to use. Available fields:

The action outputs an Id and Time, which can be referenced via bindings in later workflow steps.

Compatibility

Links

• Source code
• Report an issue
• ntfy documentation