Test Webhook

POST /v1/webhooks/{id}/test

Sends a synthetic webhook.test event to the webhook’s configured URL and returns the delivery result (HTTP status and latency). Use it to confirm a webhook endpoint is reachable and that signature verification works before relying on it. The test delivery goes through the same hardened path as real events: the resolve-and-pin SSRF egress (a test cannot reach a private/internal address) and the same HMAC signing. The attempt is recorded in the webhook’s delivery logs. Retries are disabled for the test so you get an immediate result.

Response

{
  "data": {
    "success": true,
    "status": 200,
    "response_time_ms": 142
  },
  "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}

When delivery fails, success is false and error describes why:

{
  "data": { "success": false, "response_time_ms": 5012, "error": "Request timeout" },
  "meta": { "request_id": "..." }
}

import { KnoxCall } from "@knoxcall/sdk";

const client = new KnoxCall(); // credentials from `knoxcall login` or KNOXCALL_CLIENT_ID / KNOXCALL_CLIENT_SECRET

const result = await client.webhooks.test("a1b2c3d4-...");
console.log(result.success ? `delivered in ${result.response_time_ms}ms` : result.error);

from knoxcall import KnoxCall

client = KnoxCall()  # credentials from `knoxcall login` or KNOXCALL_CLIENT_ID / KNOXCALL_CLIENT_SECRET

result = client.webhooks.test("a1b2c3d4-...")
print(f"delivered in {result['response_time_ms']}ms" if result["success"] else result["error"])

# Mint a 1-hour OAuth token (client_credentials) — see /api-reference/authentication
TOKEN=$(curl -s -X POST https://api.knoxcall.com/oauth/token \
  -u "$KNOXCALL_CLIENT_ID:$KNOXCALL_CLIENT_SECRET" \
  -d "grant_type=client_credentials" | jq -r .access_token)

curl -X POST https://api.knoxcall.com/v1/webhooks/a1b2c3d4-.../test \
  -H "Authorization: Bearer $TOKEN"

Errors

Status	Type	Description
404	`not_found`	No webhook with that ID in the current mode (Live/Sandbox)
403	`permission_denied`	Tenant policy denies the `test` action on `webhook`

Overview

Routes

Secrets

Clients

Environments

API Keys

Webhooks

Ephemeral Proxy

AI Gateway

Audit Logs

Account

Tenant KMS

Secret Store Migrations

Changelog

Test Webhook

Test Webhook

Response

Errors

​Test Webhook

​Response

​Errors

Test Webhook

Response

Errors