# PingLoom

> PingLoom is notification-as-a-service. Your server sends an event to `POST /v1/notifications` with a project API key; PingLoom stores it, sends a minimal push through FCM to the phones of the people who follow the channel, and keeps the full message in a shared team inbox. Keys are server-side only.

Notes for agents: send from the server only, keep the key in `PINGLOOM_API_KEY`, never put it in browser or mobile code, and never describe a send as "delivered": the status word is `provider_accepted`.

## Integration guide

- [Complete integration guide](https://pingloom.dev/llms-full.txt): everything in one Markdown file: stack detection, key handling, a send helper in Node and Python, errors, limits, which events to send and how to verify.

## Docs

- [Quickstart](https://pingloom.dev/docs/quickstart): create a project and key, send a first event with curl.
- [API reference](https://pingloom.dev/docs/api): fields, limits, headers, errors and the status endpoint.
- [Heartbeats](https://pingloom.dev/docs/heartbeats): `GET /v1/heartbeats/{token}` from a cron job; an alert when it goes quiet and when it recovers.
- [Decision cards](https://pingloom.dev/docs/quickstart#decisions): add a `decision` block to a notification, then poll `GET /v1/decisions` for the answer; PingLoom never acts on it.
- [Status codes](https://pingloom.dev/docs/status-codes): what each event status and delivery state means.
- [Python SDK](https://pingloom.dev/docs/sdks/python): `pip install pingloom`, `PingLoom().send(...)`, typed errors, safe retries.
- [Node SDK](https://pingloom.dev/docs/sdks/node): `npm install pingloom`, `new PingLoom().send({...})`, ESM and CommonJS, TypeScript types.
- [Command line tool](https://pingloom.dev/docs/sdks/cli): `npx pingloom send "Backup done" --channel ops`, exit codes 0, 1 and 2.
- [GitHub Action](https://pingloom.dev/docs/sdks/github-action): notify on a failed deploy from a workflow.
- [Use with AI agents](https://pingloom.dev/docs/agents): install the PingLoom skill for Claude Code and other agent tools.

## Optional

- [OpenAPI (server API)](https://pingloom.dev/openapi/pingloom-server-v1.json): machine-readable contract for the two server endpoints.
- [Pricing](https://pingloom.dev/pricing): plans and monthly event quotas.