For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Introduction
    • How Verifa Works
    • Quickstart
    • Choosing an Integration Method
  • Use Cases
    • KYC Onboarding
    • Age Verification
    • AML Compliance
    • Fraud Prevention
    • Marketplace Trust & Safety
  • Core Concepts
    • Overview
    • Sessions
    • Verifications & Checks
    • Workflows
    • Identities
    • Cases
    • Screening & Reports
    • Lists
  • Integration Guides
    • Overview
    • JavaScript SDK
    • Web Capture Flow
    • API-Only Integration
    • Mobile SDK
    • Webhooks Guide
    • MCP Server
    • Migrating from Persona
  • API Details
    • Overview
    • Authentication
    • Pagination
    • Rate Limiting
    • Versioning
    • Errors
    • Webhooks
    • Idempotency
    • Key Inflection
    • Data Access
    • Data Retention
  • Tutorials
    • Creating Your First Verification Session
    • Creating a Workflow
    • Receiving Webhooks & Validating Signatures
    • Handling Webhook Events
    • Custom Document Types & AI Extraction
  • Best Practices
    • Testing
    • Preventing Duplicates
    • Fraud Signals
    • Changelog
  • API Reference
      • POSTTest webhook delivery
      • GETList webhook endpoints
      • POSTCreate webhook endpoint
      • GETList available webhook event types
      • GETRetrieve webhook endpoint
      • DELDelete webhook endpoint
      • PATCHUpdate webhook endpoint
      • POSTRotate webhook signing secret
      • POSTClone webhook endpoint
      • GETList webhook deliveries
      • POSTRetry a failed webhook delivery
API ReferenceWebhooks

Update webhook endpoint

PATCH
https://devapi.withverifa.com/api/v1/webhooks/endpoints/:endpoint_id
PATCH
/api/v1/webhooks/endpoints/:endpoint_id
$curl -X PATCH https://devapi.withverifa.com/api/v1/webhooks/endpoints/endpoint_id \
>     -H "X-API-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "id": "wh_abc123",
3  "url": "string",
4  "environment": "live",
5  "enabled": true,
6  "enabled_events": [
7    "string"
8  ],
9  "created_at": "2024-01-15T09:30:00Z",
10  "updated_at": "2024-01-15T09:30:00Z",
11  "label": "string",
12  "description": "string",
13  "attribute_blocklist": [
14    "string"
15  ],
16  "event_filter_conditions": {},
17  "api_version": "string",
18  "key_inflection": "camel"
19}
Updates a webhook endpoint's configuration. Only provided fields are changed.
Was this page helpful?
Previous

Rotate webhook signing secret

Next
Built with

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.

Request

This endpoint expects an object.
urlstringOptionalformat: "uri"
labelstringOptional
descriptionstringOptional
enabled_eventslist of stringsOptional
enabledbooleanOptional
attribute_blocklistlist of stringsOptional
Attribute paths to exclude from webhook payloads.
event_filter_conditionsmap from strings to anyOptional
Conditional filters applied before dispatching events to this endpoint.
api_versionstring or nullOptional
key_inflectionenumOptional
Allowed values:

Response

Updated webhook endpoint.
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
422
Unprocessable Entity Error