ntfy icon

ntfy

Send message to a topic in a NTFY server

Overview

This node sends messages to a specified topic on an NTFY server, which is a lightweight notification service. It is useful for automating notifications or alerts from workflows, such as sending status updates, error alerts, or informational messages to subscribed clients or devices.

Typical use cases include:

  • Sending real-time alerts about workflow execution results.
  • Broadcasting messages to multiple subscribers interested in specific topics.
  • Integrating with monitoring systems to notify teams of important events.

For example, you could configure this node to send a high-priority message to a "deployments" topic whenever a deployment workflow completes, including a clickable URL to the deployment logs.

Properties

Name Meaning
Topic The target topic on the NTFY server where the message will be sent.
Message The main content of the notification message.
Title An optional title for the message to provide a brief summary or headline.
Priority The priority level of the message. Options: Min, Low, Default, High, Urgent (1 to 5).
Use Markdown Whether the message content should be interpreted as Markdown formatting (true/false).
Click URL An optional URL that recipients can click on within the notification.
Tags Comma-separated tags to categorize or label the message for filtering or identification.

Output

The node outputs JSON data representing the response from the NTFY server after attempting to send the message. This typically includes confirmation details or error information returned by the server.

If the request fails and the node is configured to continue on failure, the output will include the original input data along with error details for that item.

No binary data output is produced by this node.

Dependencies

  • Requires access to an NTFY server endpoint.
  • Requires an API authentication token credential to authorize requests.
  • The node uses HTTP POST requests with JSON payloads to communicate with the NTFY server.

Troubleshooting

  • Common issues:

    • Invalid or missing API token causing authorization failures.
    • Incorrect NTFY server URL leading to connection errors.
    • Malformed topic names or message content causing server rejections.
  • Error messages:

    • Authorization errors usually indicate invalid or expired API tokens; verify and update credentials.
    • Network errors suggest connectivity problems or incorrect host configuration.
    • Server-side validation errors may require checking the format and content of the message properties.
  • To handle errors gracefully, enable the "Continue On Fail" option in the node settings to allow workflow execution to proceed even if some messages fail.

Links and References

Discussion