Sending
Every notification is one HTTPS request to push.breezelabs.dev. Pick the form your tool supports; all forms accept the same parameters. Plain HTTP is not accepted.
Your key#
The key is the last part of the push link in the app. It is 27 characters long and starts with bz_d_ for one device. Links for a shared group start with bz_g_, and links for a dedicated target start with bz_t_. All three send the same way.
The key only lets someone send. It cannot read your history or manage your device. If a key leaks, reset the link in the app: the old key stops working on the next request, so update your automations with the new link.
Send with a URL#
For tools that can only open a link, put the text in the path. Encode each segment separately, for example a space as %20.
https://push.breezelabs.dev/YOUR_KEY/Body
https://push.breezelabs.dev/YOUR_KEY/Title/Body
https://push.breezelabs.dev/YOUR_KEY/Title/Subtitle/Body
Add other parameters as a query string:
https://push.breezelabs.dev/YOUR_KEY/Deploy%20finished?group=deploys&url=https://example.com
GET https://push.breezelabs.dev/v1/YOUR_KEY?body=Hello works too. These forms are compatible with Bark scripts: change the host and key, and existing paths keep working.
Send with POST#
POST to your link with plain text, form data, or JSON.
# Plain text becomes the body
curl https://push.breezelabs.dev/v1/YOUR_KEY -d 'Build passed'
# Form data
curl https://push.breezelabs.dev/v1/YOUR_KEY -d 'title=Build' -d 'body=All checks passed'
# JSON
curl https://push.breezelabs.dev/v1/YOUR_KEY \
-H 'Content-Type: application/json' \
-d '{"title":"Build","body":"All checks passed","group":"ci"}'
Keep the key out of URLs#
Links end up in proxy logs, shell history, and screenshots. For automations that run often, send to /v1/send and put the key in a header:
curl https://push.breezelabs.dev/v1/send \
-H 'Authorization: Bearer YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"title":"Backup","body":"Finished in 4 minutes"}'
Send to several devices#
List up to 20 keys in device_keys. Each device receives the notification once, even if a key repeats.
curl https://push.breezelabs.dev/push \
-H 'Content-Type: application/json' \
-d '{"device_keys":["KEY_ONE","KEY_TWO"],"title":"Server","body":"Disk usage is above 90%"}'
When iPhones and Android phones share a request, use only parameters both support. See the platform column in Parameters.
Read the response#
{"code":200,"message":"accepted","request_id":"example-request-id","data":{"accepted":1,"failed":0}}
| Status | Meaning |
|---|---|
| 200 | Apple or Google accepted it. Check the device |
| 207 | Some devices accepted it. Don't resend to the whole group |
| 404 | The key is unknown or was reset. Copy the current link from the app |
| 422 | A parameter isn't supported on the target platform |
| 429 | Too many requests. Wait for the time in Retry-After |
A network timeout can happen after delivery, so retrying may show the notification twice. Keep the request_id when you ask for help. The API reference lists every status and error.