Skip to main content

Webhooks API

Webhooks send real-time HTTP POST requests to your endpoint when events occur in FLTR.
Coming Soon: Webhooks are currently in design phase. Join the beta for early access.

Available Events

  • document.uploaded - Document upload started
  • document.processed - Document indexing complete
  • document.deleted - Document removed
  • document.processing_failed - Processing error
  • dataset.created - New dataset created
  • dataset.updated - Dataset metadata changed
  • dataset.deleted - Dataset removed
See Event Schemas for detailed payload structures.

Create Webhook

POST /v1/webhooks

Request

{
  "url": "https://your-app.com/webhooks/fltr",
  "events": ["document.processed", "document.processing_failed"],
  "description": "Production webhook",
  "active": true
}

Response

{
  "webhook_id": "wh_abc123",
  "url": "https://your-app.com/webhooks/fltr",
  "events": ["document.processed", "document.processing_failed"],
  "secret": "whsec_xyz789...",
  "created_at": "2024-01-10T12:00:00Z",
  "active": true
}

List Webhooks

GET /v1/webhooks
Returns all webhooks for your account.

Update Webhook

PATCH /v1/webhooks/{webhook_id}
Update URL, events, or active status.

Delete Webhook

DELETE /v1/webhooks/{webhook_id}
Permanently delete a webhook.

Security

All webhooks are signed with HMAC-SHA256. See Security Guide for verification details.

Retry Logic

  • Attempts: 3 retries on failure
  • Backoff: Exponential (1min, 5min, 30min)
  • Timeout: 5 seconds per attempt

Limits

  • Max 100 webhooks per account
  • Max 1,000 deliveries per hour per webhook
  • Auto-disable if >80% failure rate

Next Steps