API ReferenceWebhooks

Test webhook delivery

Sends a test webhook event to a specific endpoint. Returns the HTTP status code and any error from the delivery attempt.

Authentication

X-API-Keystring

Organization API key. Keys are prefixed with vk_live_ (production) or vk_sandbox_ (sandbox).

Path parameters

endpoint_idstringRequired

Headers

Verifa-VersiondateOptional

API version date string (e.g. 2026-02-01). If omitted, the version pinned to your API key is used.

Response

Webhook test result.
successboolean
http_statusinteger or null
HTTP status code from the endpoint.
errorstring or null
Error message if delivery failed.
urlstring or null

Errors

401
Unauthorized Error
404
Not Found Error