Webhooks Overview

Webhooks let your application receive real-time notifications when events happen in VantageKit — a prospect views your deal room, a document is downloaded, or an agreement is signed.

How it works

You register an HTTPS endpoint URL in Settings > Webhooks
You select which events to subscribe to (or all events)
When an event occurs, VantageKit sends an HTTP POST to your endpoint
Your endpoint verifies the signature, processes the event, and returns 200 OK

Webhook payload format

Every webhook delivery sends a JSON body with this structure:

{
  "type": "deal_room.viewed",
  "data": {
    "dealRoomId": "550e8400-e29b-41d4-a716-446655440000",
    "linkId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "viewerEmail": "jane@acme.com",
    "pageCount": 15,
    "duration": 300,
    "timestamp": "2026-04-08T12:34:56Z"
  }
}

type — The event type (e.g., deal_room.viewed)
data — Event-specific payload (varies by event type)

Headers

Every delivery includes these headers:

Header	Example	Description
`X-VantageKit-Signature`	`sha256=abc123...`	HMAC-SHA256 signature for verification
`X-VantageKit-Timestamp`	`1712582096`	Unix timestamp when the delivery was sent
`X-VantageKit-Event`	`deal_room.viewed`	The event type
`X-VantageKit-Delivery`	`d4e5f6a7-...`	Unique delivery ID
`Content-Type`	`application/json`	Always JSON
`User-Agent`	`VantageKit-Webhooks/1.0`	Identifies VantageKit

Requirements

HTTPS only — Webhook endpoints must use HTTPS. HTTP URLs are rejected.
Public endpoint — The URL must be publicly accessible. Local/private IPs are blocked for SSRF protection.
Respond quickly — Return a 2xx status within 10 seconds. Do heavy processing asynchronously.

Event categories

VantageKit sends 21 event types across 6 categories:

Category	Events	Description
Deal Room	5 events	Created, updated, published, archived, viewed
Document	5 events	Added, removed, published, viewed, downloaded
Viewer	2 events	Identified, email captured
Agreement	3 events	Signed, declined, expired
Link	4 events	Created, updated, clicked, expired
Team	2 events	Member joined, member removed

See the full event catalog for payload details.

Endpoint limits

Your team can have up to 10 webhook endpoints on the Scale plan. Each endpoint can subscribe to any combination of event types.

Next steps

Event catalog — All 21 events with payload examples
Security — Signature verification guide
Reliability — Retry logic, dead-letter queue, health status
Get notified on views — Step-by-step integration guide