API ReferenceWebhooks

Retrieve webhook endpoint

Returns a single webhook endpoint by its public ID.

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 endpoint details.
idstring
urlstringformat: "uri"
environmentenum
Allowed values:
enabledboolean
enabled_eventslist of strings
Event types this endpoint is subscribed to. Empty means all events.
created_atdatetime
updated_atdatetime
labelstring or null
descriptionstring or null
attribute_blocklistlist of strings
Attribute paths to exclude from webhook payloads.
event_filter_conditionsmap from strings to any
Conditional filters applied before dispatching events to this endpoint.
api_versionstring or null
key_inflectionenum
Allowed values:

Errors

401
Unauthorized Error
404
Not Found Error