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 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
Response example
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 request identifier |
Error codes
| HTTP status | Error code | Description |
|---|---|---|
| 404 | 11800001 | Webhook not found or already deleted |
| 409 | — | Webhook is not enabled |
| 502 | 11800015 | Target address did not return 2xx or the network request failed |