Skip to main content
POST
/
api
/
v1
/
webhooks
/
{id}
/
test
Test Webhook
curl --request POST \
  --url https://api.example.com/api/v1/webhooks/{id}/test
Send a test webhook to verify your endpoint is correctly configured and receiving payloads.

Request

POST /api/v1/webhooks/{id}/test
Authorization: Bearer YOUR_API_KEY

Path Parameters

ParameterTypeRequiredDescription
idstringYesUUID of the webhook to test

Response

FieldTypeDescription
successbooleanWhether the test delivery succeeded
messagestringResult message
http_statusnumberHTTP status returned by your endpoint

Test Payload

The test webhook sends a payload with "event": "test" and "is_test": true:
{
  "event": "test",
  "is_test": true,
  "timestamp": "2026-01-30T10:00:00Z",
  "test_run": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Test Webhook Delivery",
    "agent_id": "00000000-0000-0000-0000-000000000000",
    "agent_name": "Test Agent",
    "status": "completed",
    "total_scenarios": 10,
    "passed_count": 8,
    "failed_count": 2,
    "error_count": 0,
    "pass_rate": 80.0
  }
}

Examples

curl -X POST "https://app.preclinical.dev/api/v1/webhooks/uuid/test" \
  -H "Authorization: Bearer $API_KEY"

Success Response

{
  "success": true,
  "message": "Test webhook delivered successfully",
  "http_status": 200
}

Failure Response

{
  "success": false,
  "message": "Webhook returned HTTP 500",
  "http_status": 500
}

Errors

CodeDescription
NOT_FOUNDWebhook not found or doesn’t belong to your organization