ntfy Notify

Description

This module sends notifications to the ntfy.sh service, a topic-based push notification service. Its capabilities include:

1. Message with dynamic variables: The title and message support {{variable}} variables that are replaced with flow data.
2. Flexible authentication: Supports Bearer authentication (tokens tk_*) and Basic. Can use a direct token or stored credentials.
3. File sending: Supports sending one or multiple files, both local and remote (URLs). Remote files are temporarily downloaded before sending.
4. File list in message: Optionally appends the list of sent file names to the message.
5. Advanced notification options: Supports priority (1-5), tags, actions (buttons), click URL, icons, delay, email and call.
6. Markdown format: Optionally allows Markdown format in the message.

The execution flow is:

1. Processes dynamic variables in title and message.
2. Configures authentication (Bearer or Basic).
3. Sends individual files via PUT to https://ntfy.sh/{topic}.
4. Sends the main message as JSON via POST to https://ntfy.sh.

Configuration

Parameter	Type	Required	Description
credentials_id	credentials	No	Authentication credentials (username/token).
topic	text	Yes	ntfy.sh topic to send the notification to.
baseMessage	text	No	Message body. Supports dynamic variables.
title	text	No	Notification title. Default: “Notification”.
priority	number	No	Notification priority (1=min, 3=default, 5=max).
click	text	No	URL that opens when clicking the notification.
tags	text	No	Tags separated by commas (e.g.: “warning,robot”).
actions	text	No	Actions/buttons for the notification.
showFileNames	boolean	No	Append list of sent files to the message. Default: true.
filePath	text	No	Path to a local file or remote URL to attach.
filePaths	text	No	Array of file paths/URLs to attach.
fileUrls	text	No	Remote file URLs to attach.

Credentials

Optional. If provided, the object must contain username or token for authentication with ntfy.sh.

Output

{
  "nextModule": "siguiente-nodo",
  "data": {
    "topic": "mi-topico",
    "message": "Proceso completado exitosamente\n\nArchivos enviados:\n- reporte.pdf",
    "title": "Alerta de sistema",
    "priority": 4
  },
  "result": {
    "messageSent": true,
    "sentFiles": ["reporte.pdf"],
    "payload": { },
    "status": 200
  }
}

Usage Example

Basic case

{
  "topic": "mi-canal-alertas",
  "title": "Alerta: {{tipo_alerta}}",
  "baseMessage": "Se detecto un evento en {{sistema}}",
  "priority": "4",
  "tags": "warning,alert"
}

API Used

• ntfy.sh API:
  • POST https://ntfy.sh - Send JSON message.
  • PUT https://ntfy.sh/{topic} - Send file attachments.
• Documentation: https://docs.ntfy.sh/

Notes

• ntfy.sh is a free and open-source push notification service.
• Remote files (URLs) are temporarily downloaded to the system directory and deleted after sending.
• File content type is automatically detected using the mime-types library.
• Tags can be used to display icons in the notification (e.g.: “warning” shows a warning icon).
• Priority ranges from 1 (minimum) to 5 (urgent). Default is 3.
• Supports additional options like delay (scheduled sending), email (email forwarding) and call (phone call).

Related Nodes

• sendNotification (Push Notifications via Firebase)
• sendMail (Send Mail - email notifications)