SA.Automate.Ntfy 1.0.5

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 default https://ntfy.sh server for this connection.
• Access Token: optional — not required for public topics. Only needed to authenticate against a protected/private topic. If set, it's sent as an Authorization: Bearer header. Stored as a sensitive value and masked in the back office.

Both Server URL and Access Token can reference a value from appsettings.json at run time instead of storing it directly, using Umbraco Automate's configuration references. This is the recommended way to share a server URL or access token across multiple connections, or to keep secrets out of the automation database.

Setup

1. (Optional) Share a server URL or access token via configuration

If you self-host ntfy, or want a shared access token, add the values under Umbraco:Automate:Variables (non-sensitive) and Umbraco:Automate:Secrets (sensitive) in your appsettings.json (or appsettings.Production.json):

{
  "Umbraco": {
    "Automate": {
      "Variables": {
        "NtfyServerUrl": "https://ntfy.example.com"
      },
      "Secrets": {
        "NtfyToken": "tk_..."
      }
    }
  }
}

NtfyServerUrl is only needed if you're using your own self-hosted ntfy server; omit it to keep using the public https://ntfy.sh default.

Then, in the connection's Server URL field enter $Umbraco:Automate:Variables:NtfyServerUrl, and in Access Token enter $Umbraco:Automate:Secrets:NtfyToken. Automate resolves these at run time; the Access Token field only accepts Umbraco:Automate:Secrets references because it's marked sensitive.

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 (a literal value or a $Umbraco:Automate:Secrets:... reference).
3. Optionally set the Server URL for this connection (a literal value or a $Umbraco:Automate:Variables:... reference).
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