Skip to main content
Webhook

创建 Webhook

创建一个 Webhook endpoint,订阅具名事件并投递到指定回调地址。Signing Secret 只在本次响应返回,后续查询不再返回。每个 Workspace 最多创建 20 个 Webhook。

前提

已完成 Endpoint 与鉴权配置,详见API 总览与认证

接口

POST /webhook_endpoints

请求体

字段必填类型说明
urlstring回调地址;允许 HTTP 或 HTTPS,端口不限,可用域名或公网 IP;私网、回环、链路本地和保留地址会被拒绝
eventsarray<string>可订阅的具名事件类型数组,不支持通配订阅
descriptionstring描述,最长 256 个字符

请求示例

curl -X POST "$AGENTSTUDIO_URL/webhook_endpoints" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "生产环境会话事件",
    "url": "https://example.com/managedagent/webhooks",
    "events": [
      "session.updated",
      "session.status_idled",
      "session.thread_terminated"
    ]
  }'

响应

{
  "id": "wep_01JXX7YQGPRPV1BZXA35QE7WDP",
  "description": "生产环境会话事件",
  "url": "https://example.com/managedagent/webhooks",
  "events": [
    "session.updated",
    "session.status_idled",
    "session.thread_terminated"
  ],
  "status": "ACTIVE",
  "disabled_reason": null,
  "consecutive_fail": 0,
  "last_success_at": null,
  "last_failure_at": null,
  "signing_secret": "whsec_xxx",
  "created_at": "2026-08-06T10:00:00Z",
  "updated_at": "2026-08-06T10:00:00Z",
  "request_id": "8e1d16e4"
}

响应字段

字段类型说明
idstringWebhook ID,格式 wep_<ULID>
descriptionstring | null描述
urlstring回调地址
eventsarray<string>订阅的具名事件类型
statusstringWebhook 状态
disabled_reasonstring | null禁用原因,未禁用时为 null
consecutive_failinteger当前连续失败数,新建时为 0
last_success_atstring | null最近成功投递时间,新建时为 null
last_failure_atstring | null最近失败投递时间,新建时为 null
signing_secretstring验签密钥,格式 whsec_ 加标准 Base64 文本。仅在创建和重置成功响应返回
created_atstring创建时间,ISO 8601
updated_atstring最近更新时间,ISO 8601
request_idstring本次请求的唯一标识

错误码

状态码错误码说明
40011800016invalid webhook request
401InvalidApiKeyInvalid API-key provided.