Webhook Setup Guide

Last updated: March 19, 20267 min readIntermediateDeveloper

Webhooks let you receive real-time notifications when consent events occur. This guide covers setup, payload format, and best practices.

Creating a Webhook Endpoint

Go to Settings > Webhooks

Open the webhook configuration panel.

Add endpoint URL

Enter your HTTPS endpoint URL.

Select events

Choose which events trigger the webhook (consent.created, consent.updated, etc.).

Save and test

Use the test button to send a sample payload.

Payload Schema

javascript

{
  "event": "consent.created",
  "timestamp": "2026-03-18T12:00:00Z",
  "data": {
    "recordId": "...",
    "domain": "example.com",
    "consent": { "analytics": true }
  }
}

Signature Verification

javascript

const crypto = require('crypto');
const signature = req.headers['x-webhook-signature'];
const expected = crypto
  .createHmac('sha256', WEBHOOK_SECRET)
  .update(JSON.stringify(req.body))
  .digest('hex');
if (signature !== expected) throw new Error('Invalid signature');