当前为开发环境,请使用 App 为此服务器注册生成的 Webhook。
发送方式
每条通知都是一个发往 push.breezelabs.dev 的 HTTPS 请求。选择你的工具支持的方式即可,所有方式都接受相同的 参数。不接受明文 HTTP。
你的 key#
key 是 App 中推送链接的最后一段,共 27 个字符。单台设备的 key 以 bz_d_ 开头;共享分组的链接以 bz_g_ 开头,专用目标的链接以 bz_t_ 开头。三种 key 的发送方法完全相同。
key 只能用来发送,不能读取你的历史记录,也不能管理设备。如果 key 泄露,请在 App 中重置链接:旧 key 从下一次请求起失效,然后把新链接更新到你的自动化里。
用 URL 发送#
只能打开链接的工具,可以把内容放进路径。每一段都要单独编码,例如空格写成 %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
其他参数放在查询字符串里:
https://push.breezelabs.dev/YOUR_KEY/Deploy%20finished?group=deploys&url=https://example.com
GET https://push.breezelabs.dev/v1/YOUR_KEY?body=Hello 也可以。这些写法与 Bark 脚本兼容:只需替换域名和 key,原有路径照常可用。
用 POST 发送#
向你的链接 POST 纯文本、表单或 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"}'
不让 key 出现在 URL 里#
链接容易留在代理日志、命令历史和截图里。对于经常运行的自动化,请发送到 /v1/send,并把 key 放进请求头:
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"}'
发送到多台设备#
在 device_keys 中列出最多 20 个 key。即使 key 重复,每台设备也只会收到一次。
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%"}'
同一请求里同时有 iPhone 和 Android 时,只能使用两者都支持的参数,见 参数 中的平台一列。
读懂响应#
{"code":200,"message":"accepted","request_id":"example-request-id","data":{"accepted":1,"failed":0}}
| 状态 | 含义 |
|---|---|
| 200 | Apple 或 Google 已接受,请查看设备 |
| 207 | 部分设备已接受。不要向整组重发 |
| 404 | key 不存在或已重置。请从 App 复制当前链接 |
| 422 | 目标平台不支持某个参数 |
| 429 | 请求过多。请等待 Retry-After 给出的时间 |
网络超时可能发生在投递之后,此时重试可能导致通知显示两次。求助时请保留 request_id。全部状态与错误见 API 参考。