API referenceWebhooks

List recent failures for one endpoint

Try it live

playground

Path

idrequiredstring

The playground demo key has its own tenant. Run POST /v1/webhooks first; the id will auto-fill here.

Query

limitinteger

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

idrequiredstring

example 019d917e-4fa4-766e-9e0f-d977b47bf2c6

Query parameters

limitinteger

Page size; default 50, max 100.

example 50

200

Response

Recent failures

datarequiredarray<object>

metarequiredobject

meta.request_idrequiredstring

meta.countrequiredinteger

Error responses

401Missing or invalid API key

402Plan does not include webhooks — Pro or Business required

404Endpoint not found

import { Vatverify } from '@vatverify/node';
const client = new Vatverify();

const result = await client.listWebhookFailuresForEndpoint();

{
  "data": [
    {
      "id": "9b8e1a2c-4d6f-4e0b-9b2a-1c3d5e7f9a2b",
      "endpoint_id": "9b8e1a2c-4d6f-4e0b-9b2a-1c3d5e7f9a2b",
      "endpoint_label": "…",
      "event": "…",
      "delivery_id": "9b8e1a2c-4d6f-4e0b-9b2a-1c3d5e7f9a2b",
      "attempted_at": "…",
      "response_status": 0,
      "response_body": "…"
    }
  ],
  "meta": {
    "request_id": "9b8e1a2c-4d6f-4e0b-9b2a-1c3d5e7f9a2b",
    "count": 0,
    "latency_ms": 47
  }
}

Delete a webhook endpoint

List recent webhook delivery failures across all endpoints