Update Webhook

更新时间: 2026-11-16 22:11:32

Updates the description, callback URL, or subscribed events of a Webhook. Omitted fields remain unchanged.

Prerequisites

Endpoint and authentication configured. For details, see Overview and authentication.

Endpoint

PUT /webhook_endpoints/{id}

Path parameters

id string (必选)

Webhook ID, format wep_<ULID>

Request body

description string | null (可选)

Max 256 characters; null or empty string clears the description; omitted means unchanged

url string (可选)

New callback URL; re-validated when provided; private, loopback, link-local, and reserved addresses are rejected

events array<string> (可选)

Replaces the entire subscription list with named event types; omitted means unchanged

Request example

curl -X PUT "$AGENTSTUDIO_URL/webhook_endpoints/wep_01JXX7YQGPRPV1BZXA35QE7WDP" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Production Agent and Session events",
    "url": "https://example.com/managedagent/webhooks-v2",
    "events": [
      "agent.updated",
      "session.status_idled"
    ]
  }'

Response fields

id string

—

description string | null

—

url string

—

events array<string>

—

status string

—

disabled_reason string | null

—

consecutive_fail integer

Current value at the time of update

last_success_at string | null

Current value at the time of update

last_failure_at string | null

Current value at the time of update

created_at string

—

updated_at string

—

request_id string

Unique identifier for this request; include it when troubleshooting

Response

{
  "id": "wep_01JXX7YQGPRPV1BZXA35QE7WDP",
  "description": "Production Agent and Session events",
  "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"
}

Error codes

HTTP statusError codeDescription
40011800016invalid webhook request
40411800001webhook not found
上一篇: List Webhooks 下一篇: Delete Webhook
阿里云首页 大模型服务平台百炼 相关技术圈