Skip to main content

List Webhook Events

Returns delivery events for the specified Webhook from the last 7 days, sorted by event_id descending. Each event includes delivery information for the current Webhook. Returns an empty array when no records match. Past delivery events remain queryable for 7 days after Webhook deletion.

Prerequisites

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

Endpoint

GET /webhook_endpoints/{id}/events

Path parameters

FieldRequiredTypeDescription
idYesstringWebhook ID, format wep_<ULID>

Query parameters

FieldRequiredTypeDescription
limitNointegerItems per page; default 20, range 1–100
pageNostringOpaque pagination cursor; omit on the first request, pass the next_page value from the previous response on subsequent requests

Request example 

curl -X GET "$AGENTSTUDIO_URL/webhook_endpoints/wep_01JXX7YQGPRPV1BZXA35QE7WDP/events?limit=20" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response example 

{
  "data": [
    {
      "type": "event",
      "id": "whe_01JXX8JY9BBM4BK4C2P7K3M3ZR",
      "created_at": "2026-08-06T10:30:21.123Z",
      "data": {
        "id": "sesn_xxx",
        "type": "session.thread_idled",
        "workspace_id": "ws_xxx",
        "session_thread_id": "sthread_xxx"
      },
      "delivery": {
        "webhook_id": "wep_01JXX7YQGPRPV1BZXA35QE7WDP",
        "status": "SUCCEEDED",
        "attempt_count": 1,
        "delivery_at": "2026-08-06T10:30:21.450Z",
        "finish_at": "2026-08-06T10:30:21.780Z",
        "failure_reason": null
      }
    }
  ],
  "next_page": null,
  "request_id": "8e1d16e4"
}

Response fields

FieldTypeDescription
dataarray<object>Array of event objects
data[].typestringAlways event
data[].idstringEvent ID, format whe_&lt;ULID&gt;; all delivery attempts for the same event share the same outer id
data[].created_atstringEvent creation time, ISO 8601
data[].dataobjectEvent payload
data[].data.idstringResource identifier; for Thread events, this is the Session identifier
data[].data.typestringEvent type
data[].data.workspace_idstringWorkspace ID
data[].data.session_thread_idstringFor Thread events, the specific Thread identifier
data[].deliveryobjectDelivery information for the current Webhook
data[].delivery.webhook_idstringWebhook ID
data[].delivery.statusstringDelivery status, e.g. SUCCEEDED
data[].delivery.attempt_countintegerNumber of delivery attempts
data[].delivery.delivery_atstringDelivery start time, ISO 8601
data[].delivery.finish_atstringDelivery finish time, ISO 8601
data[].delivery.failure_reasonstring | nullFailure reason; null on success
next_pagestring | nullNext page cursor; null on the last page
request_idstringUnique request identifier

Error codes

HTTP statusError codeDescription
40011800016Invalid webhook ID format or pagination parameter
Managed Agent API
Flow Agent API
Sandbox API
RAG API
Long-term Memory
ParseX API
Security API
Framework Integration
Application components
More
Assistant API (Deprecated)