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

FieldRequiredTypeDescription
idYesstringWebhook 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

FieldTypeDescription
typestringAlways event
idstringEvent ID, format whe_<ULID>
created_atstringEvent creation time, ISO 8601
dataobjectEvent payload
data.idstringWebhook ID
data.typestringAlways webhook.test
data.workspace_idstringWorkspace ID
request_idstringUnique identifier of this request; include it when troubleshooting issues

Error codes

HTTP statusError codeDescription
40411800001webhook not found
409—Webhook is not enabled
50211800015Webhook endpoint returned HTTP 408, response body: request timeout