> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ntfy

The ntfy connector lets your AI agent act in each user's ntfy account. Each user connects their own ntfy access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 5 tools.

**Authentication:** Bearer Token
**Categories:** Communication, Automation
**Tools:** 5: 2 read, 2 write, 1 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=NTFY)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the ntfy connection

   In **AgentKit > Connections**, create a ntfy connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'ntfy'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize ntfy:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'ntfy_health_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "ntfy"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize ntfy:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="ntfy_health_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their ntfy credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'ntfy_health_get',
  toolInput: {},
  connector: 'ntfy',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="ntfy_health_get",
    tool_input={},
    connection_name="ntfy",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `ntfy_health_get`

Get Server Health · Read-only

Check that the ntfy server is up.
Returns healthy: true when it is.
Use this to confirm the server address is right.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `ntfy_messages_poll`

Poll Messages · Read-only

Read the messages cached on one or more topics, optionally since a time or message, including scheduled ones, filtered by priority, tags, title or message.
Returns newline-delimited JSON: one object per event with id, time, event, topic, title, message, priority, tags and attachment fields.
Pass since=<last message id> when polling repeatedly to avoid re-reading the whole cache.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `topics` (`string`, required): Topic name, or several separated by commas (up to 150). Example: backups-alerts.
- `id` (`string`, optional): Only the message with this exact ID. Example: pbkiz8SD7ZxG.
- `message` (`string`, optional): Only messages with exactly this text. Example: Backup finished.
- `priority` (`string`, optional): Only messages with any of these priorities, comma-separated (1-5 or min, low, default, high, urgent). Example: high,urgent.
- `scheduled` (`string`, optional): 1 also returns messages scheduled for later delivery. Example: 1. One of: `1`, `0`.
- `since` (`string`, optional): Return messages since a duration (10m), Unix timestamp, message ID, latest (newest message only) or all (default). Example: 10m.
- `tags` (`string`, optional): Only messages that have all of these tags, comma-separated. Example: error,backup.
- `title` (`string`, optional): Only messages with exactly this title. Example: Backup report.

Example input: `{"topics":"<topics>"}`

### `ntfy_message_publish`

Publish Message · Write

Send a push notification to an ntfy topic, with optional title, priority, tags/emojis, click URL, attachment URL, action buttons, Markdown, scheduled delivery, email or phone call.
Returns the published message with its id, time, topic and fields.
Reuse sequence_id (or a returned id) to replace an earlier notification; use ntfy_notification_clear or ntfy_notification_delete to dismiss it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `topic` (`string`, required): Topic to publish to (letters, digits, - and _, up to 64 characters). Anyone who knows a public topic name can read it, so use hard-to-guess names or reserved topics. Example: backups-alerts.
- `actions` (`array`, optional): Up to 3 action buttons. Each has action (view, broadcast, http or copy), label, and for view and http a url; http actions can also set method, headers and body. Example: [{"action": "view", "label": "Open dashboard", "url": "https://status.example.com"}]
- `attach` (`string`, optional): URL of a file to attach to the notification. Example: https://example.com/report.pdf.
- `call` (`string`, optional): Also place a voice call reading the message to this verified phone number (or yes). Needs a plan that includes calls. Example: +12223334444.
- `click` (`string`, optional): URL opened when the notification is tapped. Example: https://status.example.com.
- `delay` (`string`, optional): Schedule delivery: a Unix timestamp, a duration such as 30min, or a time such as 9am or tomorrow 10am (10 seconds to 3 days ahead). Example: 30min.
- `email` (`string`, optional): Also send the notification to this email address (or yes for your verified address). Rate limited, and may need a paid plan on ntfy.sh. Example: ops@example.com.
- `filename` (`string`, optional): File name shown for the attachment. Example: report.pdf.
- `icon` (`string`, optional): URL of a JPEG or PNG icon for the notification (Android). Example: https://example.com/icon.png.
- `markdown` (`boolean`, optional): Render the message as Markdown (web app and Android). Example: false.
- `message` (`string`, optional): Notification body. Defaults to triggered when empty. Example: Disk space is low at 5.1 GB.
- `priority` (`integer`, optional): Priority from 1 (min) to 5 (max); 3 is the default, 4 high, 5 urgent. Example: 4. One of: `1`, `2`, `3`, `4`, `5`.
- `sequence_id` (`string`, optional): Sequence ID that links updates: publishing again with the same ID replaces the earlier notification. Example: my-download-123.
- `tags` (`array`, optional): Tags; names that match an emoji short code (for example warning, white_check_mark) are shown as emojis. Example: ["warning", "backup"]
- `timezone` (`string`, optional): IANA time zone for natural-language delay values. Example: Europe/Berlin.
- `title` (`string`, optional): Notification title. Example: Low disk space alert.

Example input: `{"topic":"<topic>"}`

### `ntfy_notification_clear`

Clear Notification · Write

Mark a delivered notification as read and dismiss it on subscribed clients.
Returns the message_clear event.
Use ntfy_notification_delete to remove it from clients entirely.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `sequence_id` (`string`, required): Sequence ID of the notification: the sequence_id you published with, or the message id returned when it was published. Example: my-download-123.
- `topic` (`string`, required): Topic name (letters, digits, - and _, up to 64 characters). Example: backups-alerts.

Example input: `{"sequence_id":"<sequence_id>","topic":"<topic>"}`

### `ntfy_notification_delete`

Delete Notification · Destructive

Remove a notification from subscribed clients, or cancel a scheduled message that has not been delivered yet.
Returns the message_delete event.
Use ntfy_notification_clear to only mark it as read.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `sequence_id` (`string`, required): Sequence ID of the notification: the sequence_id you published with, or the message id returned when it was published. Example: my-download-123.
- `topic` (`string`, required): Topic name (letters, digits, - and _, up to 64 characters). Example: backups-alerts.

Example input: `{"sequence_id":"<sequence_id>","topic":"<topic>"}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
