Test Webhook
Updated at:
Sends a webhook.test POST request to the Webhook's callback URL. Success is returned only after the callback responds with 2xx. The test is not retried, does not save delivery records, and does not affect the consecutive failure count.
Prerequisites
Endpoint and authentication configured. For details, see API overview and authentication.
Endpoint
POST /webhook_endpoints/{id}/test
Path parameters
| Field | Required | Type | Description |
|---|---|---|---|
id | Yes | string | Webhook ID, format wep_<ULID> |
Request example
curl -X POST "$AGENTSTUDIO_URL/webhook_endpoints/wep_01JXX7YQGPRPV1BZXA35QE7WDP/test" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY"
Response
{
"type": "event",
"id": "whe_01JXX8JY9BBM4BK4C2P7K3M3ZR",
"created_at": "2026-08-06T10:30:21.123Z",
"data": {
"id": "wep_01JXX7YQGPRPV1BZXA35QE7WDP",
"type": "webhook.test",
"workspace_id": "ws_xxx"
},
"request_id": "8e1d16e4"
}
Response fields
| Field | Type | Description |
|---|---|---|
type | string | Always event |
id | string | Event ID, format whe_<ULID> |
created_at | string | Event creation time, ISO 8601 |
data | object | Event payload |
data.id | string | Webhook ID |
data.type | string | Always webhook.test |
data.workspace_id | string | Workspace ID |
request_id | string | Unique identifier of this request; include it when troubleshooting issues |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 404 | 11800001 | webhook not found |
| 409 | — | Webhook is not enabled |
| 502 | 11800015 | Webhook endpoint returned HTTP 408, response body: request timeout |
Is this page helpful?