Getting started

Pinglet turns a single HTTP request into a native push notification on iOS and Android. You publish a message to a topic with one POST; everyone subscribed to that topic in the Pinglet app gets a push. Receiving needs no account — the subscription link itself is the capability.

1. Get an API key

Sign in at app.pinglet.co.uk and create a namespace — the container your topics live under (for example acme). Then mint a publish key from your namespace dashboard. Keys look like pinglet_<64 hex characters> and are shown once, at creation — store it somewhere safe.

Publishing is authenticated; receiving is not. Only the sender needs a key.

2. Publish a message

Point a POST at your topic’s URL. The topic is created automatically on first publish:

curl -X POST https://app.pinglet.co.uk/acme/deploys \
  -H "Authorization: Bearer $PINGLET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Deploy done","message":"v1.2.3 is live","level":"success"}'

The response includes everything you need to share the topic:

{
  "message_id": 42,
  "topic": "acme/<key>",
  "key": "<key>",
  "name": "deploys",
  "url": "https://app.pinglet.co.uk/acme/deploys/<key>",
  "subscribers": 0,
  "delivered": 0,
  "failed": 0
}

Install the Pinglet app (App Store, Google Play), then open the url from the publish response on your phone — or paste it into Add a subscription, or scan its QR code from the dashboard. No sign-up needed.

Publish again and your phone lights up:

curl -X POST https://app.pinglet.co.uk/acme/deploys \
  -H "Authorization: Bearer $PINGLET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message":"Checkout API · 5xx spiking","priority":"urgent","level":"error"}'

Core concepts

Concept	What it is
Namespace	The container you own (e.g. `acme`). API keys are scoped to a namespace.
Topic	A named channel inside a namespace. Publishers address it by name; subscribers hold its unguessable key.
Subscription	A device following a topic. Anonymous — the shared link is the only credential.
API key	A `Bearer` token that authorizes publishing into a namespace.

Where next

Publishing — both publish endpoints, auth, and the full response format.
Message anatomy — titles, priority, levels, badges, and metadata.
Subscribing & the app — sharing links, QR codes, history, and live feeds.
Integrations — hook up anything that can send a webhook, plus guides for Uptime Kuma and Alertmanager.

Getting started

1. Get an API key

2. Publish a message

3. Subscribe on your phone

Core concepts

Where next