Skip to main content
Ntfy logo
  • Category: notifications
  • Auth: API_KEY, BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: NTFY
  • Version: 20261101_00

Tools

Slug: NTFY_CREATE_ACCOUNTTool to register a new user account on ntfy. Use when you need to create a new user account on the ntfy.sh hosted service. Note: This endpoint is not available on self-hosted instances unless signup is explicitly enabled in the server configuration.

Input Parameters

string
required
The password for the new account. Should be strong and secure.
string
required
The desired username for the new account. Must be unique and meet format requirements (typically alphanumeric with certain special characters allowed).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_CREATE_WEBPUSH_SUBSCRIPTIONTool to register a web push subscription for browser notifications. Use when you need to enable push notifications from ntfy topics through a browser’s native push notification system.

Input Parameters

string
required
The authentication secret from the browser’s push subscription, used to authenticate messages. Base64-encoded auth secret.
string
required
The P-256 elliptic curve Diffie-Hellman public key from the browser’s push subscription, used for message encryption. Base64-encoded public key.
array
List of ntfy topic names to subscribe to. Maximum of 50 topics allowed. If user authentication is enabled, the user must have read access to all specified topics.
string
required
The push service endpoint URL from the browser’s push subscription. Must be from an approved domain (*.google.com, *.googleapis.com, Mozilla, Microsoft, Apple push services).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_DELETE_WEBPUSH_SUBSCRIPTIONTool to unregister a web push subscription from the ntfy server. Use when you need to remove browser push notifications for a previously registered endpoint.

Input Parameters

string
required
The web push subscription endpoint URL to delete. This is the browser-provided push endpoint (e.g., from fcm.googleapis.com, Mozilla, Microsoft, or Apple push services) that was previously registered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_FETCH_SCHEDULED_MESSAGESTool to fetch messages scheduled for later delivery from a topic. Use when you need to retrieve messages that are set to be delivered at a future date. The poll=1 and scheduled=1 parameters are automatically set to retrieve cached scheduled messages in a single request.

Input Parameters

string
Base64-encoded authentication query parameter as alternative to Authorization header for protected topics.
string
required
Topic name to fetch scheduled messages from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_GET_ACCOUNTTool to retrieve account data for authenticated user or anonymous user. Use when you need to get account information, limits, statistics, or tier details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_GET_STATSTool to retrieve server statistics including message counts and publishing rates. Use when you need to monitor ntfy server activity and get metrics about message volume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_GET_TIERSTool to list all available ntfy service tiers with their limits and features. Use when you need to retrieve subscription tier information including pricing and usage limits. Requires that payments are enabled on the server.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_HEAD_FILETool to get file attachment metadata from a message without downloading the file content. Use when you need to check file size, content type, or verify file existence in the ntfy attachment cache.

Input Parameters

string
required
The unique identifier for the message/file attachment. Must be 1-64 characters consisting of alphanumeric characters, hyphens, or underscores. An optional file extension may be appended (e.g., .txt, .jpg).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_HEALTH_CHECKTool to check the health status of the ntfy service. Use when you need to verify if the ntfy service is operational and responding correctly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_PUBLISH_MESSAGETool to publish a message to a ntfy topic. Use when you need to send notifications or alerts to a topic. Topics are created dynamically if they don’t exist.

Input Parameters

string
URL to a custom icon image to display with the notification.
string
Comma-separated list of emoji shortcodes or text tags to display with the notification.
string
URL to open when the notification is clicked.
string
Schedule the notification for delayed delivery (e.g., ‘30m’, ‘1h’, ‘tomorrow 10am’). Minimum delay is 10 seconds, maximum is 3 days.
string
Email address to forward the notification to.
string
Optional notification title. If not provided, topic name is used.
string
required
The topic name to publish the message to. Topic will be created dynamically if it doesn’t exist.
string
URL of a file to attach to the notification.
string
Action button definitions (maximum 3 buttons per message). Format: ‘action, label, url; …’
string
required
The message body text to publish.
string
Custom filename for the attachment (only used if attach is specified).
boolean
Enable Markdown formatting in the message body. Default is False.
integer ("1" | "2" | "3" | "4" | "5")
Priority level (1=min, 2=low, 3=default, 4=high, 5=max/urgent). Default is 3.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_PUBLISH_VIA_GETTool to publish messages to ntfy via GET request with URL parameters. Use when PUT/POST methods are unavailable or for simple webhook integration. Supports all message parameters as query strings. Without parameters, sends ‘triggered’ as message.

Input Parameters

string
Authentication credentials as query parameter.
string
Trigger phone call notification (phone number or ‘yes’).
string
Notification icon URL.
string
Comma-separated list of emoji/tag identifiers.
string
Control message caching behavior.
string
Target URL opened when notification is clicked.
string
Schedule delivery using duration or timestamp (e.g., ‘30m’, ‘1h’, ‘tomorrow 10am’).
string
Forward notification to specified email address.
string
Notification title that overrides the topic name.
string
required
The topic name to publish the message to. This will be part of the URL path.
string
Attachment file URL.
string
Custom action button definitions (string format for GET requests).
string
Custom message body text. If not provided, defaults to ‘triggered’.
string
Custom attachment filename (only used if attach is specified).
string
Control Firebase push notification behavior.
boolean
Enable Markdown formatting in message body.
integer
Urgency level from 1-5 (1=min, 3=default, 5=max). Default is 3 if not specified.
string
Template name for JSON transformation (e.g., ‘github’, ‘grafana’, ‘alertmanager’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NTFY_SUBSCRIBE_RAW_STREAMRetrieve a topic’s message bodies as raw text, with optional filtering and polling. Polling requests cached messages and closes the connection; a non-polling request can remain open, so the tool may not return while the stream is open.

Input Parameters

string
Filter returning only exact message ID matches.
boolean
Return cached messages and close connection. If true (poll=1), returns all cached messages and closes connection. If false or not set, streams messages in real-time.
string
Filter by comma-separated tags. Returns messages matching all listed tags.
string
Return cached messages since timestamp, duration or message ID. Examples: ‘10m’, ‘1645970742’, ‘nFS3knfcQ1xe’, ‘all’, ‘latest’.
string
Filter for exact title string matches.
string
required
The topic name to subscribe to.
string
Filter for exact message body matches.
string
Filter by comma-separated priorities. Returns messages matching any listed priority.
boolean
Include scheduled/delayed messages in message list. Set to true to include scheduled messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not