API reference
See the full endpoint reference for webhook subscriptions, deliveries, replay, rotation, and event
types.
Why use webhooks?
- React immediately when vault ingestion, OCR, transcription, matter, billing, or deployment events finish.
- Reduce polling for long-running jobs and update your UI from delivery events.
- Scope subscriptions by event type, vault, or matter so each receiver only gets what it needs.
- Recover safely with delivery history, manual replay, retries, and endpoint auto-disable.
Quick example
id, type, occurred_at, and data payload for the event.
Event filters
Use exact names for narrow subscriptions, prefix wildcards for a service area, or* for every event your API key can receive.
Add
resourceScopes.vaultIds or resourceScopes.matterIds when an endpoint should only receive events for specific resources.
Delivery behavior
Delivery is at least once. Store processed event IDs and make your handler idempotent.
Retries run inline first, then in the background. Repeated failures can auto-disable an endpoint until you re-enable it from the dashboard or API.
Endpoints
Quickstart
Create an endpoint, verify signatures, and send a test event.
Event types
Generated reference for subscribable events and payload shapes.
API reference
OpenAPI reference for endpoint, delivery, replay, rotation, and catalog APIs.

