List Webhooks

Prerequisites

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

Endpoint

GET /webhook_endpoints

Request example

curl -X GET "$AGENTSTUDIO_URL/webhook_endpoints" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response example

{
  "data": [
    {
      "id": "wep_01JXX7YQGPRPV1BZXA35QE7WDP",
      "description": "Production session events",
      "url": "https://example.com/managedagent/webhooks",
      "events": [
        "session.updated",
        "session.status_idled",
        "session.thread_terminated"
      ],
      "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:00:00Z"
    }
  ],
  "request_id": "8e1d16e4"
}

Response fields

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

Error codes

HTTP status	Error code	Description
401	`InvalidApiKey`	Invalid API key provided

​Prerequisites

​Endpoint

​Request example

​Response example

​Response fields

​Error codes

Prerequisites

Endpoint

Request example

Response example

Response fields

Error codes