Quick start

1. Pair your iPhone

Install the PeskyBird app, then open your dashboard and scan the pairing code with the app. Pairing your first phone creates the alerts topic and subscribes the phone to it, so the message below reaches it.

2. Create an app token

On the dashboard's App tokens page, create a token for each script or service. A token is shown once, starts with pba_, and can be limited to the topics it may send to. Keep it secret: anyone with it can send to your phones. Revoke it on the same page.

3. Send a message

POST the text to a topic. The body is the message; nothing else is needed.

curl -H "Authorization: Bearer pba_…" \
  -d "Nightly backup completed in 4 min" \
  https://peskybird.app/api/push/topics/alerts

A 201 response means the message was stored and handed to Apple's push service. Its JSON says how many devices it went to; see the API reference.

The basics

• Base URL: https://peskybird.app/api/push. Every path in these docs is relative to it.
• Authentication: Authorization: Bearer pba_… with an app token, on every request.
• Topics group messages on the phone. Sending to a topic that does not exist yet creates it with auto subscribe on, so every paired phone gets its messages. Turn auto subscribe off for a topic on your dashboard's Topics page, and each phone can unsubscribe from a topic in the app.
• History: a phone that was offline gets every message it missed, in order, when it comes back.

Next: every option a message can carry, or the limits on each account.