API reference
Everything a script, CI job or server can call with an app token. Generated from the protocol specification the server runs on.
Base URL
https://peskybird.app/api/pushAuthentication
Authorization: Bearer pba_… with a token from the dashboard's App tokens page.Errors
One JSON envelope for every error. Error codesEndpoints
Sending
POSTSend text to a topic/topics/{topicName}The one-line form. The topic is in the path; the body is plain text or JSON.POSTSend a JSON message
/messagesThe JSON form, with the topic in the body. Every option is available.GETCheck a send
/sends/{id}What happened to a message you sent: how many devices it was handed to, and how many the push service accepted.
Your account
GETCheck your token/tokenChecks a token without sending anything: its name, the topics it may send to and its account.GETList your topics
/topicsThe topics a token may send to, and how many devices receive each, so you know someone will get the message.GETCheck your limits
/limitsHow much of the daily message limit is used and when it resets, plus the other limits, without sending.GETList your devices
/devicesThe paired devices and the topics each receives. Put their ids in a send's `devices` to reach only some of them.
Tools
Import every request into Postman, ready to send: set the collection's appToken variable to your token. Or generate a client from the OpenAPI document.