Update Webhook

Prerequisites

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

Endpoint

PUT /webhook_endpoints/{id}

Path parameters

Field	Required	Type	Description
`id`	Yes	string	Webhook ID, format `wep_<ULID>`

Request body

Omitted fields remain unchanged.

Field	Required	Type	Description
`description`	No	string \| null	Max 256 characters; `null` or empty string clears the description; omitted means unchanged
`url`	No	string	New callback URL; re-validated when provided; private, loopback, link-local, and reserved addresses are rejected
`events`	No	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 example

{
  "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"
}

Response fields

Field	Type	Description
`id`	string	Webhook ID
`description`	string \| null	Description
`url`	string	Callback URL
`events`	array<string>	Subscribed named event types
`status`	string	Webhook status: `ACTIVE` or `DISABLED`
`disabled_reason`	string \| null	Disable reason; `null` when not disabled
`consecutive_fail`	integer	Current consecutive failure count at the time of update
`last_success_at`	string \| null	Last successful delivery time at the time of update
`last_failure_at`	string \| null	Last failed delivery time at the time of update
`created_at`	string	Creation time, ISO 8601
`updated_at`	string	Last update time, ISO 8601
`request_id`	string	Unique request identifier

Error codes

HTTP status	Error code	Description
400	`11800016`	Invalid request parameter
404	`11800001`	Webhook not found

​Prerequisites

​Endpoint

​Path parameters

​Request body

​Request example

​Response example

​Response fields

​Error codes

Prerequisites

Endpoint

Path parameters

Request body

Request example

Response example

Response fields

Error codes