Webhook

Update Webhook

Update a Webhook's description, callback URL, or subscribed events

PUT

/api/v1/agentstudio/webhook_endpoints/{id}

cURL

curl --request PUT \
  --url 'https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/webhook_endpoints/{id}' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "生产环境 Agent 与 Session 事件",
  "url": "https://example.com/managedagent/webhooks-v2",
  "events": [
    "agent.updated",
    "session.status_idled"
  ]
}
'

{
  "id": "wep_01JXX7YQGPRPV1BZXA35QE7WDP",
  "description": "生产环境 Agent 与 Session 事件",
  "url": "https://example.com/managedagent/webhooks-v2",
  "events": [
    "agent.updated",
    "session.status_idled"
  ],
  "status": "ACTIVE",
  "disabled_reason": null,
  "consecutive_fail": 2,
  "last_success_at": "2026-08-06T10:05:00Z",
  "last_failure_at": "2026-08-06T10:10:00Z",
  "created_at": "2026-08-06T10:00:00Z",
  "updated_at": "2026-08-06T10:15:00Z",
  "request_id": "8e1d16e4"
}

Authorizations

string

header

required

DashScope API Key

Path Parameters

string

required

Webhook ID，格式 wep_<ULID>

Body

application/json

string | null

最长 256 个字符；null 或空字符串表示清空，字段缺省表示保持不变

string

新回调地址；传入时重新校验，私网、回环、链路本地和保留地址会被拒绝

string[]

使用具名事件类型替换整个订阅列表；字段缺省表示保持不变

Response

200-application/json

string

string | null

string

string[]

enum<string>

Available options:ACTIVE,DISABLED

string | null

integer

返回更新完成时的当前值

string | null

返回更新完成时的当前值

string | null

返回更新完成时的当前值

string

cURL

curl --request PUT \
  --url 'https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/webhook_endpoints/{id}' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "生产环境 Agent 与 Session 事件",
  "url": "https://example.com/managedagent/webhooks-v2",
  "events": [
    "agent.updated",
    "session.status_idled"
  ]
}
'

{
  "id": "wep_01JXX7YQGPRPV1BZXA35QE7WDP",
  "description": "生产环境 Agent 与 Session 事件",
  "url": "https://example.com/managedagent/webhooks-v2",
  "events": [
    "agent.updated",
    "session.status_idled"
  ],
  "status": "ACTIVE",
  "disabled_reason": null,
  "consecutive_fail": 2,
  "last_success_at": "2026-08-06T10:05:00Z",
  "last_failure_at": "2026-08-06T10:10:00Z",
  "created_at": "2026-08-06T10:00:00Z",
  "updated_at": "2026-08-06T10:15:00Z",
  "request_id": "8e1d16e4"
}