ATKONBASE

外观

Webhook 错误码（177*） ​

段位：177001 - 177099；当前 6 个；全部 V1 暴露

通用约定（HTTP status / code=1 兜底 / 响应结构）见 README

经 V1 /v1/webhooks/* 端点暴露：webhook 配置管理（创建 / 查询 / 改状态 / 删除）、投递记录查询与重投、事件类型列举。

177001 WEBHOOK_NOT_FOUND ​

  • HTTP status：200
  • 含义：Webhook 配置不存在
  • 典型触发条件：以一个不存在（或已删除）的 webhookId 调用获取 / 更新状态 / 删除 webhook
  • 处理建议：先调用 webhook 分页查询确认 webhookId 有效，再执行后续操作
  • 示例响应：
json
{ "code": 177001, "msg": "Webhook 不存在: wh_xxx", "data": null }

177002 WEBHOOK_STATUS_INVALID ​

  • HTTP status：200
  • 含义：无效的 Webhook 状态
  • 典型触发条件：更新 webhook 状态时传入了非法的 status 值（合法值为 ACTIVE / PAUSED）
  • 处理建议：检查 status 取值，仅使用受支持的枚举值
  • 示例响应：
json
{ "code": 177002, "msg": "无效的Webhook状态: FOO", "data": null }

177003 WEBHOOK_EVENT_TYPES_REQUIRED ​

  • HTTP status：200
  • 含义：订阅的事件类型不能为空
  • 典型触发条件：创建 / 更新 webhook 时未提供任何订阅事件类型
  • 处理建议：至少提供一个事件类型；通配符 * 表示订阅全部事件
  • 示例响应：
json
{ "code": 177003, "msg": "订阅的事件类型不能为空", "data": null }

177004 WEBHOOK_EVENT_TYPE_UNSUPPORTED ​

  • HTTP status：200
  • 含义：不支持的事件类型
  • 典型触发条件：订阅的事件 code 不在事件类型注册表中、已被标记 DEPRECATED、或为空白
  • 处理建议：调用 GET /v1/webhooks/event-types 获取当前可订阅事件类型清单，仅订阅其中 ACTIVE 的 code（或用 * 通配）
  • 示例响应：
json
{ "code": 177004, "msg": "不支持的事件类型: foo.bar", "data": null }

177005 WEBHOOK_EVENT_TYPE_REGISTRY_NOT_READY ​

  • HTTP status：200
  • 含义：事件类型注册表尚未初始化
  • 典型触发条件：服务刚启动、事件类型清单尚未就绪的极短时间窗口内创建 webhook（瞬态，稍后即恢复）
  • 处理建议：稍后重试；若持续出现，携带响应中的 rid / X-Request-Id 联系 ATKONBASE 支持团队
  • 示例响应：
json
{ "code": 177005, "msg": "事件类型注册表尚未初始化，请稍后重试: doc.created", "data": null }

177006 WEBHOOK_DELIVERY_NOT_FOUND ​

  • HTTP status：200
  • 含义：Webhook 投递记录不存在
  • 典型触发条件：以不存在的 deliveryId 调用投递重投（redeliver）
  • 处理建议：先调用投递记录分页查询确认 deliveryId 有效，再触发重投
  • 示例响应：
json
{ "code": 177006, "msg": "Webhook 投递记录不存在: dl_xxx", "data": null }