NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Ntfy connects to a Nagent workspace with an API key. Once it is connected, agents can call 12 Ntfy actions, such as "Create NTFY Account", "Create Web Push Subscription" and "Get Account Information". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Ntfy, with input parameters and output schema.
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
The password for the new account. Should be strong and secure.
The desired username for the new account. Must be unique and meet format requirements (typically alphanumeric with certain special characters allowed).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The authentication secret from the browser's push subscription, used to authenticate messages. Base64-encoded auth secret.
The P-256 elliptic curve Diffie-Hellman public key from the browser's push subscription, used for message encryption. Base64-encoded public key.
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.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Base64-encoded authentication query parameter as alternative to Authorization header for protected topics.
Topic name to fetch scheduled messages from.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
URL to a custom icon image to display with the notification.
Comma-separated list of emoji shortcodes or text tags to display with the notification.
URL to open when the notification is clicked.
Schedule the notification for delayed delivery (e.g., '30m', '1h', 'tomorrow 10am'). Minimum delay is 10 seconds, maximum is 3 days.
Email address to forward the notification to.
Optional notification title. If not provided, topic name is used.
The topic name to publish the message to. Topic will be created dynamically if it doesn't exist.
URL of a file to attach to the notification.
Action button definitions (maximum 3 buttons per message). Format: 'action, label, url; ...'
The message body text to publish.
Custom filename for the attachment (only used if attach is specified).
Enable Markdown formatting in the message body. Default is False.
Priority level (1=min, 2=low, 3=default, 4=high, 5=max/urgent). Default is 3.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Authentication credentials as query parameter.
Trigger phone call notification (phone number or 'yes').
Notification icon URL.
Comma-separated list of emoji/tag identifiers.
Control message caching behavior.
Target URL opened when notification is clicked.
Schedule delivery using duration or timestamp (e.g., '30m', '1h', 'tomorrow 10am').
Forward notification to specified email address.
Notification title that overrides the topic name.
The topic name to publish the message to. This will be part of the URL path.
Attachment file URL.
Custom action button definitions (string format for GET requests).
Custom message body text. If not provided, defaults to 'triggered'.
Custom attachment filename (only used if attach is specified).
Control Firebase push notification behavior.
Enable Markdown formatting in message body.
Urgency level from 1-5 (1=min, 3=default, 5=max). Default is 3 if not specified.
Template name for JSON transformation (e.g., 'github', 'grafana', 'alertmanager').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
NTFY_SUBSCRIBE_RAW_STREAMTool to subscribe to a topic and receive message bodies as raw text stream. Use when you need to retrieve messages without metadata like priority, tags, or titles. Each line in the response contains only the message body. Empty lines represent keepalive messages. In streaming mode, the connection remains open to receive new messages. With poll=1, cached messages are returned and the connection closes.
Input parameters
Filter returning only exact message ID matches.
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.
Filter by comma-separated tags. Returns messages matching all listed tags.
Return cached messages since timestamp, duration or message ID. Examples: '10m', '1645970742', 'nFS3knfcQ1xe', 'all', 'latest'.
Filter for exact title string matches.
The topic name to subscribe to.
Filter for exact message body matches.
Filter by comma-separated priorities. Returns messages matching any listed priority.
Include scheduled/delayed messages in message list. Set to true to include scheduled messages.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 Ntfy actions on Nagent, including "Create NTFY Account", "Create Web Push Subscription" and "Get Account Information". Create NTFY Account: Register a new user account on ntfy. Each action is listed on this page with its input parameters and its output.
Ntfy connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create NTFY Account takes 2 required inputs: password and username. It returns data, error and successful.