跳转到内容

配置团队 Webhook

Request

新增或替换团队的 Webhook 配置。

  • 前置条件callbackUrl 必须是 1 到 1024 个字符的 HTTPS 地址,带主机名,不含用户信息与片段,端口合法。它解析到的每个地址都必须是公网可路由的;localhost、内网、链路本地、CGNAT、云元数据、协议保留、文档示例与 6to4 等范围会被拒绝。实际建连时会再校验一次,因此某个域名若之后解析到内网范围,只会导致该次投递失败,不会打到你的内网。
  • 副作用:按服务端上下文所属团队做唯一配置的 upsert。teamId 不从请求读取,因此调用方无法配置其他团队。Local API 与 Open API 两个入口读写同一份记录,响应会回显已保存的内容。
  • 停用enabled: false 会保留地址并停止创建新事件。已排队的事件在下次被授权时若配置仍处于停用状态,会被逐条取消;因此快速重新启用可以让它们继续投递。
  • 重试:安全。保存是按团队的 upsert,重复发送同一请求会收敛到同一状态。
  • 客户端版本:需要 MoreLogin 客户端 v2.66.0 或更高版本,因为本地这条路由是由桌面客户端暴露的。Open API 入口不依赖客户端。

回调契约、事件名称与重试节奏见 Webhooks

已记录的业务错误码:41001。 各错误码的含义见 Error Codes。任何接口还可能返回通用错误码。

Bodyapplication/json
callbackUrlstring, <= 1024 charactersrequired

接收事件的 HTTPS 地址。1 到 1024 个字符。

enabledbooleanrequired

该团队是否启用投递。

POST
/api/webhook/config
curl -i -X POST \
  http://127.0.0.1:40000/api/webhook/config \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  }'

Responses

成功。data 是包含 callbackUrlenabled 字段的对象,回显已保存的配置。

Headers
any
Bodyapplication/json
codeintegerrequired

返回结果码,0 表示正常,其他码为异常。

msgstring or nullrequired

错误信息

dataobjectrequired
requestIdstringrequired

操作请求 ID

Response
{ "code": 0, "msg": "", "data": { "callbackUrl": "https://example.com/morelogin/webhook", "enabled": true }, "requestId": "" }