Get Webhook
Updated at:
Retrieves the details of a single Webhook by ID. The signing secret is not returned in this response.
Prerequisites
Endpoint and authentication configured. For details, see Overview and authentication.
Endpoint
GET /webhook_endpoints/{id}
Path parameters
| Field | Required | Type | Description |
|---|---|---|---|
id | Yes | string | Webhook ID, format wep_<ULID> |
Request example
curl -X GET "$AGENTSTUDIO_URL/webhook_endpoints/wep_01JXX7YQGPRPV1BZXA35QE7WDP" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY"
Response example
{
"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 |
|---|---|---|
id | string | Webhook ID, format wep_<ULID> |
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 |
last_success_at | string | null | Last successful delivery time |
last_failure_at | string | null | Last failed delivery time |
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 |
|---|---|---|
| 404 | 11800001 | Webhook not found, deleted, or does not belong to the current workspace |
Is this page helpful?