Test Webhook Subscription — POST /api/v1/webhooks/{subscription_id}/test
Test Webhook Subscription
Emit a synthetic run.completed event to this subscription so the customer can verify their receiver without waiting for a real run. Creates a real WebhookDelivery row so history reflects the test alongside production deliveries.
Endpoint: POST /api/v1/webhooks/{subscription_id}/test
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA lead or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
subscription_id | path | yes | string (uuid) | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | WebhookTestResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Outbound Webhooks
- Operation ID:
test_webhook_subscription_api_v1_webhooks__subscription_id__test_post - Source code:
backend/app/routers/webhooks_outbound.py, line 173 - Specification: OpenAPI JSON