Skip to main content
当账户可用积分低于你设定的阈值,或创建任务时余额不足,平台会向你配置的 HTTPS 地址发送一次 POST。你不需要用 API Key 来接收这条请求。
Webhook 在控制台 充值页 的 余额通知 中配置:选择 Webhook,填写地址和可选密钥,打开启用开关后保存。

你需要准备什么

  1. 一个公网可访问的 http 或 https URL(不能指向本机 localhost)。
  2. (推荐)一段密钥,用于校验 X-Sigrunai-Signature。
  3. 接收端在约 10 秒内返回 2xx。当前实现发送一次,不自动重试。
同一用户在余额回升前,同类通知 24 小时内最多一次。

请求

请求头

Body 字段

事件类型

示例:余额低于阈值

示例:余额不足无法下单

校验签名(推荐)

签名对象是 原始请求体字节,不是格式化后的 JSON。
把结果编成小写 hex,与头里 sha256= 后面的值做恒定时间比较。
必须使用 HTTP 层读到的原始 body。重新 JSON.stringify 后再签会失败。
建议同时检查时间戳:若与当前时间相差超过 5 分钟,直接拒绝。

Node.js

Python

未配置密钥时没有 X-Sigrunai-Signature。此时请用防火墙或仅内网 URL 保护端点。

对接建议

  • 先返回 2xx,再异步处理业务(发钉钉、补余额、暂停任务等)。
  • 用 event 分流,不要假设每次都有 threshold 或 required。
  • 可用余额也可主动查询 /user/balance。
  • 告警通道是 邮箱或 Webhook 二选一,选 Webhook 后同类提醒不再发邮件。
最后修改于 2026年10月15日