# Notifly for developers

Canonical page: https://notifly.io/developers

The Notifly developer platform: REST API, interactive reference, OpenAPI 3.x
spec, a remote MCP server for AI agents, and a free plan you can start on without
a credit card.

## Trigger a notification

```bash
curl -X POST https://api.notifly.io/v1/events/trigger \
  -H "Authorization: ApiKey $NOTIFLY_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"<workflow-id>","to":{"subscriberId":"<subscriber-id>"},"payload":{"body":"Hello from Notifly"}}'
```

## Surfaces

- REST API — one versioned `/v1` surface for workflows, subscribers, topics and
  messages: https://notifly.io/docs/api
- Interactive reference, one page per operation: https://notifly.io/docs/api-reference
- OpenAPI document: https://api.notifly.io/openapi.json
- Remote MCP server (OAuth 2.1): https://api.notifly.io/mcp
- Agent setup instructions (MCP + SDK + verify, for any coding agent): https://notifly.io/agent-setup/prompt.md
- Per-agent setup guides: https://notifly.io/agent-setup
- Channel-agent onboarding (connect a Notifly agent to Slack, Teams and more): https://notifly.io/agents.md

## Onboard your coding agent

Paste this sentence into Claude Code, Codex, Cursor, OpenCode or any other coding agent:

> Fetch and execute the appropriate instructions to set me up for Notifly from https://notifly.io/agent-setup/prompt.md

## MCP operations

Served through Code Mode (the `search_tools` and `execute_typescript` tools): `list_organizations`, `trigger_workflow`, `list_workflows`, `get_workflow`, `list_subscribers`, `get_subscriber`, `list_topics`, `list_notifications`.

Add it to a client:

```bash
claude mcp add --transport http notifly https://api.notifly.io/mcp
```

## Server SDKs

- Node.js / TypeScript: `npm install @notiflyio/api@0.1.26`
- Python: `pip install notifly-sdk==0.1.0`

## Client SDKs on npm

`@notiflyio/js`, `@notiflyio/react`, `@notiflyio/nextjs`, `@notiflyio/react-native`,
`@notiflyio/web-push`, `@notiflyio/capacitor-push`.