notifly
Get started
Agent setup

Onboard your agent to Notifly.

Copy one sentence and paste it into your AI coding agent. It fetches the setup instructions, connects the Notifly MCP server with an OAuth sign-in, stores your secret key in a git-ignored .env, installs the SDK and verifies the connection.

prompt — what the pill copies
Fetch and execute the appropriate instructions to set me up for Notifly from https://notifly.io/agent-setup/prompt.md
01 — Pick your agent

Or set it up by hand.

Claude Code

One terminal command, then an OAuth sign-in in the browser.

Open the guide

Codex

One terminal command, then an OAuth sign-in in the browser.

Open the guide

Cursor

One MCP config entry, then an OAuth sign-in in the browser.

Open the guide

OpenCode

One MCP config entry, then an OAuth sign-in in the browser.

Open the guide

Windsurf

One MCP config entry, then an OAuth sign-in in the browser.

Open the guide

VS Code + GitHub Copilot

One MCP config entry, then an OAuth sign-in in the browser.

Open the guide

02 — What you get

Seven MCP tools and a typed SDK.

The tools act with the permissions you grant on the consent screen, never more than your own role. trigger_workflow stays off until an admin enables Settings → Connected apps → “Allow AI clients to trigger notifications”.

MCP tools

  • trigger_workflow

    Fire a workflow for a subscriber (the one write tool; off until an admin enables it)

  • list_workflows

    Search and page through workflows

  • get_workflow

    Fetch a single workflow's details

  • list_subscribers

    Search and page through subscribers

  • get_subscriber

    Fetch a single subscriber

  • list_topics

    Search and page through topics

  • list_notifications

    Read notification history

Server SDKs

Any other language calls the REST API directly — see the API reference.

03 — Verify

Prove the key works.

Run it from the project root: the first two lines load NOTIFLY_SECRET_KEY from .env and stop if it is empty, then the request prints HTTP 200 and a body containing totalCount. A 401 with the key loaded means the key is wrong or belongs to a different environment. Inside the agent, calling the list_workflows tool proves the MCP sign-in the same way.

bash — verify
if [ -f .env ]; then set -a; . ./.env; set +a; fi
: "${NOTIFLY_SECRET_KEY:?NOTIFLY_SECRET_KEY is not set: store it in .env first (step 1)}"
curl -sS -w "\nHTTP %{http_code}\n" -H "Authorization: ApiKey $NOTIFLY_SECRET_KEY" "https://api.notifly.io/v2/workflows?limit=1"

The agent reads notifly.io/agent-setup/prompt.md — plain markdown you can read too. Optional next step: to wire a Notifly agent into Slack, Microsoft Teams or another channel, follow notifly.io/agents.md.