API referenceWebhooks
Fire a test event to a registered endpoint
Delivers a `test` event directly (bypasses the delivery queue) so you can verify your endpoint is reachable.
Try it live
playgroundPath
The playground demo key has its own tenant. Run POST /v1/webhooks first; the id will auto-fill here.
30 requests per hour per IP · demo key used automatically
Auth
Requires the
Authorization: Bearer <api_key> header. Use a vtv_live_* key in production or a vtv_test_* key for deterministic magic-number responses.Path parameters
idrequiredstringexample
019d917e-4fa4-766e-9e0f-d977b47bf2c6200
Response
Test event delivered
deliveredrequiredbooleanexample
truestatusrequiredintegerexample
200Error responses
401Missing or invalid API key
402Plan does not include webhooks — Pro or Business required
404Endpoint not found or belongs to a different key
import { Vatverify } from '@vatverify/node';
const client = new Vatverify();
const result = await client.testWebhook();{
"delivered": true,
"status": 200
}