用途:通过 Notifery API 向用户发送通知,适合在任务完成、失败或需要进度提醒时使用,也可在构建、部署、迁移等长时间任务结束后主动通知。
主要能力:调用 POST /event 发送通知。title 为唯一必填字段(1-255 字符);可选字段包括 message(最多 2048 字符)、group、code(0 表示成功,大于 0 表示错误)、duration(毫秒)、ttl(60-31536000 秒)、icon、iconColor(十六进制颜色)。成功响应为 {"ok": true}。
使用方式:基础地址为 https://api.notifery.com,可用 NOTIFERY_API_URL 环境变量覆盖;认证使用请求头 x-api-key: $NOTIFERY_API_KEY。开始工作流前先检查密钥:test -n "$NOTIFERY_API_KEY" || echo "ERROR: NOTIFERY_API_KEY is not set",未设置时应停止并提示用户设置。若设置了 NOTIFERY_DEFAULT_GROUP 且未提供 group,则使用该默认分组。发送示例:curl -s -f -X POST "${NOTIFERY_API_URL:-https://api.notifery.com}/event" -H "x-api-key: $NOTIFERY_API_KEY" -H "Content-Type: application/json" -d '{"title":"TITLE","message":"MESSAGE","group":"GROUP"}'。只包含有值的字段。
错误处理:curl 使用 -f 在 HTTP 错误时失败;如需查看状态码,可去掉 -f 并加 -w "\n%{http_code}"。常见错误为 401(API 密钥错误)和 422(参数无效)。
限制:资料未提供价格、平台支持范围、速率限制或配额等信息。