API Webhooks
SDD Classification: L3-Technical
Authority: Engineering Team
Review Cycle: Quarterly
Webhook Overview
Setting Up Webhooks
Create Webhook Endpoint
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
Testing Webhooks
Test Endpoint
Send a test event to your webhook:Local Development
Use tools like ngrok for local testing:Best Practices
Endpoint Design
- Respond quickly - Return 200 immediately, process async
- Idempotency - Handle duplicate deliveries
- Logging - Log all webhook receipts
- Queuing - Queue events for processing
Example Handler
Related Documentation
- API Overview - API fundamentals
- Authentication - Webhook auth
- Events - Event schema reference
Document Status: Complete Version: 2.0