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.
| Filter | Matches |
|---|---|
vault.ingest.completed | One exact event type. |
vault.ingest.* | Every event beginning with vault.ingest. |
vault.* | Every event beginning with vault. |
* | Every subscribable event in the generated list. |
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.| Receiver result | Case.dev behavior |
|---|---|
2xx response | Delivery is marked delivered. |
408, 429, 5xx | Delivery is retried. |
| Network error or timeout | Delivery is retried. |
Other 4xx | Delivery fails without retry. |
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.

