Ntfy icon

Ntfy

Accesses the ntfy.sh API

Overview

This node integrates with the ntfy.sh service to publish messages to specified topics. It is useful for sending notifications or alerts to subscribers of a topic in real-time. Typical use cases include system monitoring alerts, chat message broadcasting, or any scenario where you want to push messages to multiple recipients subscribed to a topic.

For example, you can configure this node to publish a message titled "Server Down" with details about the outage to a topic named "alerts". Subscribers listening to the "alerts" topic will receive the notification instantly.

Properties

Name Meaning
Topic The topic name under which the message will be published. Subscribers to this topic receive the message.
Message The content/body of the message to be sent.
Title The title or headline of the message.
Additional Fields Optional extra parameters; currently supports:
- Click Action: URL or action triggered when the message is clicked.

Output

The node outputs JSON data representing the response from the ntfy.sh API after publishing the message. This typically includes confirmation of the message delivery status and any metadata returned by the service.

No binary data output is involved.

Dependencies

  • Requires access to the public ntfy.sh API endpoint (https://ntfy.sh).
  • No explicit authentication credentials are required as per the provided code.
  • Network connectivity to the ntfy.sh service must be available.

Troubleshooting

  • Common Issues:

    • Publishing may fail if the topic name is invalid or contains unsupported characters.
    • Network errors if the ntfy.sh service is unreachable.
    • Missing required fields (Topic, Message, Title) will prevent successful publishing.
  • Error Messages:

    • Errors related to HTTP request failures usually indicate connectivity issues or incorrect API usage.
    • Validation errors occur if required properties are empty or missing; ensure all mandatory fields are filled.

Links and References

Discussion