Overview
The Webhooks API queues HTTP POST delivery attempts for selected organization events. Delivery and replay behavior remains Beta; consumers must tolerate duplicates, authenticate requests, and monitor missing or permanently failed deliveries. See the current project status.
All webhook management endpoints require organization owner or admin permissions.
Key Features
- Queued event delivery: HTTP POST attempts after selected events occur
- Automatic retries: Exponential backoff with up to five attempts
- Signature verification: HMAC-SHA256 signatures and timestamps
- Delivery tracking: Recorded attempts, responses, and retry state
- Event filtering: Subscribe to selected event types
- Active/inactive toggle: Pause delivery without deleting configuration
Endpoints Summary
| Method | Path | Description |
|---|---|---|
POST |
/api/organizations/:org_slug/webhooks |
Create a webhook |
GET |
/api/organizations/:org_slug/webhooks |
List webhooks |
GET |
/api/organizations/:org_slug/webhooks/:webhook_id |
Get webhook details |
PATCH |
/api/organizations/:org_slug/webhooks/:webhook_id |
Update webhook configuration |
DELETE |
/api/organizations/:org_slug/webhooks/:webhook_id |
Delete a webhook |
GET |
/api/organizations/:org_slug/webhooks/:webhook_id/deliveries |
List delivery attempts |
GET |
/api/organizations/:org_slug/webhooks/event-types |
List available event types |
Choose a webhook task
| Need | Focused reference |
|---|---|
| Create, list, update, disable, or delete webhooks | Configuration |
| Authenticate deliveries and limit replay attacks | Signing and verification |
| Inspect delivery attempts and understand retry behavior | Delivery and retries |
| Select events or inspect payload shapes | Event catalog |
| Implement and operate a receiver | Receiver examples |
| Diagnose API or delivery failures | Troubleshooting |
Webhooks are not an exactly-once delivery channel. Verify every signature, reject stale timestamps, deduplicate delivery IDs, acknowledge quickly, and reconcile critical state through the authoritative API.
Published-anchor compatibility
This overview remains the stable published route. The headings below retain the original fragment identifiers and direct existing links to focused references.
Webhook Management
POST /api/organizations/:org_slug/webhooks
GET /api/organizations/:org_slug/webhooks
GET /api/organizations/:org_slug/webhooks/:webhook_id
PATCH /api/organizations/:org_slug/webhooks/:webhook_id
DELETE /api/organizations/:org_slug/webhooks/:webhook_id
Webhook Delivery
Continue in delivery and retries.
GET /api/organizations/:org_slug/webhooks/:webhook_id/deliveries
Continue in delivery and retries.
Retry Logic
Continue in delivery and retries.
Rate Limiting
Continue in delivery and retries.
Event Types
GET /api/organizations/:org_slug/webhooks/event-types
Available Event Types
Webhook Payload Structure
Example Payloads
Security
Continue in signing and verification.
Signature Verification
Continue in signing and verification.
Error Responses
Common Errors
Complete Workflow Example
Continue in receiver examples.
1. Create Webhook
Continue in receiver examples.
2. Implement Webhook Endpoint
Continue in receiver examples.
3. Monitor Deliveries
Continue in receiver examples.
4. Handle Failed Deliveries
Continue in receiver examples.
Best Practices
Continue in receiver examples.
Webhook Design
Continue in receiver examples.
Endpoint Implementation
Continue in receiver examples.
Monitoring & Maintenance
Continue in receiver examples.
Security
Continue in receiver examples.