API referenceWebhooks

Update webhook label or enabled state

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.

Body

labelstringnullenabledboolean

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

Body

labelstringnull

Human-readable name for this endpoint. Shown in the dashboard. Pass null to clear.

example production

enabledboolean

Pause (false) or resume (true) deliveries without deleting the endpoint.

example true

200

Response

Updated

datarequiredobject

data.idrequiredstring

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

data.urlrequiredstring

example https://example.com/webhooks/vatverify

data.labelrequiredstring | null

data.enabledrequiredboolean

data.last_delivery_atrequiredstring | null

data.last_delivery_statusrequiredinteger | null

data.created_atrequiredstring

example 2026-04-15T10:00:00Z

Error 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.updateWebhook({
    "label": "production",
    "enabled": true
  });

{
  "data": {
    "id": "019d917e-4fa4-766e-9e0f-d977b47bf2c6",
    "url": "https://example.com/webhooks/vatverify",
    "label": "…",
    "enabled": true,
    "last_delivery_at": "…",
    "last_delivery_status": 0,
    "created_at": "2026-04-15T10:00:00Z"
  }
}

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.