Test Webhooks Locally
How to receive webhook events on your local development machine.
VantageKit webhooks require a publicly accessible HTTPS endpoint. During development, use a tunneling service to expose your local server.
Using ngrok
ngrok creates a secure tunnel from a public URL to your local machine.
Start your local webhook server
node server.js
# Listening on port 3000Start ngrok tunnel
ngrok http 3000ngrok will display a forwarding URL like:
Forwarding https://a1b2c3d4.ngrok-free.app -> http://localhost:3000Register the webhook in VantageKit
Go to Settings > Webhooks > Create Webhook Endpoint and enter:
- URL:
https://a1b2c3d4.ngrok-free.app/webhooks/vantagekit - Events: Select
deal_room.viewed,document.viewed, or whichever events you need
Now trigger a view event by opening one of your deal rooms in a browser. You should see the webhook delivery hit your local server.
Using webhook.site
For quick inspection without writing any code, use webhook.site:
Get your unique URL
Go to webhook.site — you'll get a unique URL automatically.
Register as a webhook endpoint
Register that URL as a webhook endpoint in Settings > Webhooks.
Trigger events and inspect
Trigger events and see the raw payloads, headers, and delivery metadata in the webhook.site dashboard. This is great for inspecting payload shapes before writing your handler.
Viewing delivery logs
VantageKit keeps a delivery log for each webhook endpoint:
- Go to Settings > Webhooks
- Click on your endpoint
- View the delivery history — each entry shows status, HTTP response code, and timestamps
You can use this to debug failed deliveries and see exactly what payload was sent.
Tips
ngrok URLs change every time you restart (unless you have a paid plan). Update your webhook endpoint URL in VantageKit after restarting.
- Use the
X-VantageKit-Eventheader to filter events in your development logs. - The
X-VantageKit-Deliveryheader contains a unique delivery ID — useful for correlating logs.