Skip to main content

API Webhooks

SDD Classification: L3-Technical Authority: Engineering Team Review Cycle: Quarterly
Webhooks enable your application to receive real-time notifications when events occur in Materi. This guide covers webhook setup, event types, security, and best practices.

Webhook Overview


Setting Up Webhooks

Create Webhook Endpoint

Response:

Webhook Properties


Event Types

Document Events

Workspace Events

Collaboration Events

AI Events


Webhook Payload Format

Standard Payload Structure

Payload Properties


Webhook Security

Signature Verification

Every webhook includes a signature header for verification:

Verifying Signatures

Python Verification


Delivery & Retries

Retry Policy

Retry Schedule

Response Requirements

  • Timeout: 30 seconds
  • Success: 2xx status codes
  • Failure: 4xx, 5xx, or timeout

Managing Webhooks

List Webhooks

Update Webhook

Delete Webhook

View Delivery History

Response:

Testing Webhooks

Test Endpoint

Send a test event to your webhook:

Local Development

Use tools like ngrok for local testing:

Best Practices

Endpoint Design

  1. Respond quickly - Return 200 immediately, process async
  2. Idempotency - Handle duplicate deliveries
  3. Logging - Log all webhook receipts
  4. Queuing - Queue events for processing

Example Handler



Document Status: Complete Version: 2.0