Quickstart

This guide connects an agentic development repo to Agent Notifier and sends one notification through the production API.

1. Get an account API key

Open the Agent Notifier web app at https://notifier.aicrew.in/app or the iOS app and go to API Keys. Create an account API key, then copy it once.

API keys are shown once when created or rotated. Store them in a local environment variable or secret manager; do not commit them.

export AGENT_NOTIFIER_API_KEY="an_key_REPLACE_WITH_YOUR_KEY"
export AGENT_NOTIFIER_API_BASE="${AGENT_NOTIFIER_API_BASE:-https://notifier.aicrew.in/api/v1}"
export AGENT_NOTIFIER_PROJECT="Docs Quickstart"

2. Install the agent harness

From the repository you want monitored, run:

AGENT_NOTIFIER_URL="${AGENT_NOTIFIER_URL:-https://notifier.aicrew.in}"
curl -fsSL "$AGENT_NOTIFIER_URL/install.sh" | bash

The installer scaffolds Copilot and Claude hooks, writes .env.local, and appends a short Agent Notifier note to CLAUDE.md so future agents know to send timely progress updates. It does not commit or print your API key.

You can also share https://notifier.aicrew.in/skill.md with an agent and ask it to install Agent Notifier for the current repo.

3. Send a notification

If you have the standalone notify.py CLI installed locally, it can use the same environment variables:

notify.py "Your agent can now reach your phone." \
  --title "Hello from Agent Notifier" \
  --project "Docs Quickstart"

The CLI requires an API key from env/local config, generates a client_event_id automatically for safe retries, and does not send local filesystem paths unless you explicitly opt in.

Equivalent raw API call:

CLIENT_EVENT_ID="$(uuidgen | tr '[:upper:]' '[:lower:]')"

curl -sS -X POST "$AGENT_NOTIFIER_API_BASE/messages" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $AGENT_NOTIFIER_API_KEY" \
  --data @- <<JSON
{
    "project": "$AGENT_NOTIFIER_PROJECT",
    "client_event_id": "$CLIENT_EVENT_ID",
    "type": "alert",
    "title": "Hello from Agent Notifier",
    "message": "Your agent can now reach your phone.",
    "priority": 0
}
JSON

A successful response returns HTTP 202 with a notification ID:

{
  "id": "00000000-0000-0000-0000-000000000000",
  "delivered_at": "2026-04-26T00:00:00Z"
}

4. Verify delivery

Check the iOS app feed for the new card. If the project is not muted and push permissions are enabled, you should also receive an APNs notification.

5. Add richer fields

Try client_event_id, event, tool_name, command, prompt, file_paths, parent_id, subagent_id, status, fixed display color, progress, attachment, server-side audio fields (as_audio, voice, voice_engine, speed), url, url_title, deprecated image_url, buttons, sound, ttl, and device as needed. See [Messages](messages.md) for the full payload contract.

6. Automate agent feedback

For Copilot and Claude Code hooks, use the public installer, the shareable Skill.md, or adapt the hook request shape. See [Hooks](hooks.md).