# NoticeFox

> NoticeFox delivers rich, animated notifications to a person's iPhone, Apple Watch and Vision Pro. A sender (script, Home Assistant, CI job or AI agent) holds a send token (`nfx_send_…`) and sends a notification with one HTTPS request: `POST {base URL}/v1/notifications` with `Authorization: Bearer <token>` and a JSON body such as `{"title": "Build", "message": "Finished"}`. The answer is `202 Accepted`.

The base URL is configuration (the docs use `https://api.noticefox.app`, the NoticeFox service, and `$NOTICEFOX_URL`): use the one for the user's token, never a guess; a test service has its own. Treat the token as a secret: keep it out of URLs, logs and chat where you can.

## Docs

- [Full reference for agents](llms-full.txt): everything needed to send a notification correctly, in one file
- [Getting started](getting-started.md): get a send token and send a first notification
- [curl examples](curl.md): the JSON endpoint and the key-in-URL simple endpoint
- [Fields and limits](fields.md): every send field, limits, aliases, precedence and conflicts, levels and Pushover priorities, scenes
- [Error codes](errors.md): every error code, its HTTP status, and whether to retry
- [Quotas and rate limits](quotas.md): monthly sends, per-minute bursts, and the rate-limit headers
- [Security and redaction](security.md): credentials, keeping a token safe, and what the service logs
- [Authorization](authorization.md): what each credential may do

## Integrations

- [Home Assistant](home-assistant.md): a REST notifier and a `rest_command`
- [Apprise](apprise.md): the `jsons://` plugin, with its default payload

## Optional

- [Docs home](index.md): the page index for people