# Ntfy

```json
{
  "name": "Ntfy",
  "slug": "ntfy",
  "url": "https://composio.dev/toolkits/ntfy",
  "markdown_url": "https://composio.dev/toolkits/ntfy.md",
  "logo_url": "https://logos.composio.dev/api/ntfy",
  "categories": [
    "productivity & project management",
    "collaboration & communication",
    "workflow automation"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-03-29T06:43:41.259Z"
}
```

![Ntfy logo](https://logos.composio.dev/api/ntfy)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Ntfy MCP or direct API to send instant push notifications, trigger alerts, broadcast updates, and automate device messages through natural language.

## Summary

Ntfy is a notification service to send push messages to phones or desktops. Instantly deliver alerts and updates to users, devices, or teams.

## Categories

- productivity & project management
- collaboration & communication
- workflow automation

## Toolkit Details

- Tools: 22

## Images

- Logo: https://logos.composio.dev/api/ntfy

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Ntfy.
  - Setup:
    - Configure Api Key credentials for Ntfy.
    - Use the credentials when creating an auth config in Composio.
- **Basic**
  - Type: `basic_auth`
  - Description: Basic authentication for Ntfy.
  - Setup:
    - Configure Basic credentials for Ntfy.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Send push notification for build failures
- Notify me of high-priority alerts
- Broadcast message to all devices

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `NTFY_CREATE_ACCOUNT` | Create NTFY Account | Tool 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. |
| `NTFY_CREATE_WEBPUSH_SUBSCRIPTION` | Create Web Push Subscription | Tool 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. |
| `NTFY_DELETE_WEBPUSH_SUBSCRIPTION` | Delete Web Push Subscription | Tool to unregister a web push subscription from the ntfy server. Use when you need to remove browser push notifications for a previously registered endpoint. |
| `NTFY_FETCH_CACHED_MESSAGES` | Fetch Cached Messages | Tool to fetch cached messages from a ntfy topic. Use when you need to retrieve previously sent messages stored on the server. Supports filtering by time (duration or timestamp), message ID, content, title, priority, and tags. Set poll=1 to return immediately after fetching available cached messages. |
| `NTFY_FETCH_LATEST_MESSAGE_FROM_TOPIC` | Fetch Latest Message from Topic | Tool to fetch the most recent message from a topic's cache. Use when you need to retrieve the latest message without subscribing to the topic stream. |
| `NTFY_FETCH_SCHEDULED_MESSAGES` | Fetch Scheduled Messages | Tool 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. |
| `NTFY_GET_ACCOUNT_INFORMATION` | Get Account Information | Tool to retrieve account data for authenticated user or anonymous user. Use when you need to get account information, limits, statistics, or tier details. |
| `NTFY_GET_SERVER_STATISTICS` | Get Server Statistics | Tool 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. |
| `NTFY_GET_SERVICE_TIERS` | Get Service Tiers | Tool 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. |
| `NTFY_GET_FILE_ATTACHMENT_METADATA` | Get File Attachment Metadata | Tool 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. |
| `NTFY_CHECK_NTFY_SERVICE_HEALTH` | Check NTFY Service Health | Tool to check the health status of the ntfy service. Use when you need to verify if the ntfy service is operational and responding correctly. |
| `NTFY_POLL_MESSAGES_FROM_TOPIC` | Poll Messages from Topic | Tool to poll for messages from an ntfy topic without maintaining a long-standing connection. Use when you need to retrieve cached messages and have the connection close immediately after delivery. The connection ends after reading all available messages matching the criteria. |
| `NTFY_PUBLISH_MESSAGE_AS_JSON_TO_NTFY` | Publish Message as JSON to NTFY | Tool to publish messages as JSON to ntfy. Use when you need to send notifications with all parameters in the request body, especially useful for integrations that cannot add custom headers. |
| `NTFY_PUBLISH_MESSAGE_TO_TOPIC` | Publish Message to Topic | Tool 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. |
| `NTFY_PUBLISH_MESSAGE_TO_TOPIC_PUT` | Publish Message to Topic (PUT) | Tool to publish a message to a topic using PUT method. Use when you need to send notifications to subscribers of a topic. Supports various options like priority, tags, attachments, and scheduled delivery. |
| `NTFY_PUBLISH_MESSAGE_VIA_GET` | Publish Message via GET | Tool 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. |
| `NTFY_SEND_MESSAGE_VIA_WEBHOOK` | Send Message via Webhook | Tool to send messages via webhook endpoint using simple GET request. Use when you need a simple webhook-style integration or for clients with limited HTTP support. |
| `NTFY_SUBSCRIBE_TO_NTFY_TOPIC_WITH_FILTERS` | Subscribe to NTFY Topic with Filters | Tool to subscribe to a ntfy topic with filters based on message fields (id, message, title, priority, tags). Use when you need to retrieve specific messages from a topic using filter criteria. Returns matching messages from the topic as a JSON stream. |
| `NTFY_SUBSCRIBE_TO_TOPIC_JSON_STREAM` | Subscribe to Topic (JSON Stream) | Tool to subscribe to a ntfy topic and receive messages as JSON stream. Use when you need to retrieve cached messages from a topic. The action polls the topic and returns immediately with cached messages. |
| `NTFY_SUBSCRIBE_TO_MULTIPLE_NTFY_TOPICS` | Subscribe to Multiple NTFY Topics | Tool to subscribe to multiple ntfy topics simultaneously using comma-separated topic list. Use when you need to receive messages from multiple topics in a single API call. Returns cached messages when used with poll=true parameter. |
| `NTFY_SUBSCRIBE_TO_TOPIC_RAW_STREAM` | Subscribe to Topic (Raw Stream) | Tool 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. |
| `NTFY_TRIGGER_NTFY_WEBHOOK` | Trigger NTFY Webhook | Tool to trigger a webhook to publish a message to an ntfy topic via simple HTTP GET request. Use when you need to send notifications through webhooks without requiring a POST body. Sends a default 'triggered' message if no custom message is provided. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Ntfy Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Ntfy actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'Send a push notification to my device with "Daily report is ready"'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'Send a push notification to my device with "Daily report is ready"'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK for Python or TypeScript
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Initialize Client and Create Tool Router Session

Import and initialize the Composio client, then create a Tool Router session for Ntfy
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });
const session = await composio.create('your-user-id');
console.log(`Tool Router session created: ${session.mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent (Anthropic Claude or Mastra)
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Ntfy tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Send a push notification to "engineering" topic with "Build succeeded"')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: session.mcp.url,
    headers: {
      'x-api-key': 'your-composio-api-key',
    },
  },
});

const tools = await client.tools();
const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{
    role: 'user',
    content: 'Send a push notification to "engineering" topic with "Build succeeded"'
  }],
  maxSteps: 5,
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Ntfy Integration

- Supports both Ntfy MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable tool execution
- Rich coverage for reading, writing, and querying your Ntfy data

### 2. Managed Auth

- Built-in OAuth handling with automatic token refresh and rotation
- Central place to manage, scope, and revoke Ntfy access
- Per user and per environment credentials instead of hard-coded keys

### 3. Agent Optimized Design

- Tools are tuned using real error and success rates to improve reliability over time
- Comprehensive execution logs so you always know what ran, when, and on whose behalf

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Ntfy
- Scoped, least privilege access to Ntfy resources
- Full audit trail of agent actions to support review and compliance

## Use Ntfy with any AI Agent Framework

Choose a framework you want to connect Ntfy with:

- [ChatGPT](https://composio.dev/toolkits/ntfy/framework/chatgpt)
- [Antigravity](https://composio.dev/toolkits/ntfy/framework/antigravity)
- [OpenAI Agents SDK](https://composio.dev/toolkits/ntfy/framework/open-ai-agents-sdk)
- [Claude Agent SDK](https://composio.dev/toolkits/ntfy/framework/claude-agents-sdk)
- [Claude Code](https://composio.dev/toolkits/ntfy/framework/claude-code)
- [Claude Cowork](https://composio.dev/toolkits/ntfy/framework/claude-cowork)
- [Codex](https://composio.dev/toolkits/ntfy/framework/codex)
- [Cursor](https://composio.dev/toolkits/ntfy/framework/cursor)
- [VS Code](https://composio.dev/toolkits/ntfy/framework/vscode)
- [OpenCode](https://composio.dev/toolkits/ntfy/framework/opencode)
- [OpenClaw](https://composio.dev/toolkits/ntfy/framework/openclaw)
- [Hermes](https://composio.dev/toolkits/ntfy/framework/hermes-agent)
- [Google ADK](https://composio.dev/toolkits/ntfy/framework/google-adk)
- [LangChain](https://composio.dev/toolkits/ntfy/framework/langchain)
- [Vercel AI SDK](https://composio.dev/toolkits/ntfy/framework/ai-sdk)
- [Mastra AI](https://composio.dev/toolkits/ntfy/framework/mastra-ai)
- [LlamaIndex](https://composio.dev/toolkits/ntfy/framework/llama-index)
- [CrewAI](https://composio.dev/toolkits/ntfy/framework/crew-ai)
- [Pydantic AI](https://composio.dev/toolkits/ntfy/framework/pydantic-ai)
- [AutoGen](https://composio.dev/toolkits/ntfy/framework/autogen)

## Related Toolkits

- [Gmail](https://composio.dev/toolkits/gmail) - Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable.
- [Outlook](https://composio.dev/toolkits/outlook) - Outlook is Microsoft's email and calendaring platform for unified communications and scheduling. It helps users stay organized with powerful email, contacts, and calendar management.
- [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly.
- [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place.
- [Slack](https://composio.dev/toolkits/slack) - Slack is a channel-based messaging platform for teams and organizations. It helps people collaborate in real time, share files, and connect all their tools in one place.
- [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations.
- [Gong](https://composio.dev/toolkits/gong) - Gong is a platform for video meetings, call recording, and team collaboration. It helps teams capture conversations, analyze calls, and turn insights into action.
- [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals.
- [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem.
- [Linear](https://composio.dev/toolkits/linear) - Linear is a modern issue tracking and project planning tool for fast-moving teams. It helps streamline workflows, organize projects, and boost productivity.
- [Microsoft teams](https://composio.dev/toolkits/microsoft_teams) - Microsoft Teams is a collaboration platform that combines chat, meetings, and file sharing within Microsoft 365. It keeps distributed teams connected and productive through seamless virtual communication.
- [Jira](https://composio.dev/toolkits/jira) - Jira is Atlassian’s platform for bug tracking, issue tracking, and agile project management. It helps teams organize work, prioritize tasks, and deliver projects efficiently.
- [Clickup](https://composio.dev/toolkits/clickup) - ClickUp is an all-in-one productivity platform for managing tasks, docs, goals, and team collaboration. It streamlines project workflows so teams can work smarter and stay organized in one place.
- [Slackbot](https://composio.dev/toolkits/slackbot) - Slackbot is a conversational automation tool for Slack that handles reminders, notifications, and automated responses. It boosts team productivity by streamlining onboarding, answering FAQs, and managing timely alerts—all right inside Slack.
- [Monday](https://composio.dev/toolkits/monday) - Monday.com is a customizable work management platform for project planning and collaboration. It helps teams organize tasks, automate workflows, and track progress in real time.
- [2chat](https://composio.dev/toolkits/_2chat) - 2chat is an API platform for WhatsApp and multichannel text messaging. It streamlines chat automation, group management, and real-time messaging for developers.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [Agent mail](https://composio.dev/toolkits/agent_mail) - Agent mail provides AI agents with dedicated email inboxes for sending, receiving, and managing emails. It empowers agents to communicate autonomously with people, services, and other agents—no human intervention needed.
- [Agiled](https://composio.dev/toolkits/agiled) - Agiled is an all-in-one business management platform for CRM, projects, and finance. It helps you streamline workflows, consolidate client data, and manage business processes in one place.
- [Apilio](https://composio.dev/toolkits/apilio) - Apilio is a home automation platform that lets you connect and control smart devices from different brands. It helps you build flexible automations with complex conditions, schedules, and integrations.

## Frequently Asked Questions

### Do I need my own developer credentials to use Ntfy with Composio?

Yes, Ntfy requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)