Setting Up Webhooks

Webhooks let you notify external systems automatically when changes occur in your Metapad model.

What Are Webhooks?

A webhook is an HTTP callback — when something changes in your model, Metapad sends an HTTP POST request to a URL you specify, containing details about what changed.

Creating a Webhook

Open your model settings
Navigate to the Webhooks Tab
Click Add Webhook
Configure:
- URL: The endpoint that will receive notifications (must be HTTPS)
- Events: Which changes to notify about (e.g., node created, relationship deleted)
- Name: A descriptive name for this webhook
Click Save

Webhook Payload

When an event occurs, Metapad sends a JSON payload including:

Event type (what happened)
Affected element details (node/relationship data)
Timestamp
Model ID

Use Cases

Slack/Teams notifications: "A new requirement was added to the model"
CI/CD triggers: Automatically run validation when the architecture model changes
Data sync: Keep an external database in sync with your model
Audit logging: Record all changes in an external system

Requirements

Webhooks require a Pro plan or higher
The receiving endpoint must be publicly accessible (or reachable from Metapad's servers)
HTTPS is required for security

Tips

Test your webhook endpoint with a simple echo service first
Handle retries gracefully — webhooks may be delivered more than once
Use webhook names that describe the integration (e.g., "Slack #architecture-changes")