Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.case.dev/llms.txt

Use this file to discover all available pages before exploring further.

Vault lifecycle events are delivered through the platform-wide Events API. Use vault webhooks when you want to:
  • update UI state when uploads or ingestion finish
  • trigger downstream workflows after documents become searchable
  • avoid polling vault object status endpoints

Subscribe to vault events

Create a webhook endpoint with a vault event filter:
Create vault endpoint
curl -X POST https://api.case.dev/webhooks/v1/endpoints \
  -H "Authorization: Bearer $CASEDEV_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.example.com/webhooks/casedev",
    "description": "Vault lifecycle receiver",
    "eventTypeFilters": ["vault.*"]
  }'
For a single vault or a small set of vaults, add resourceScopes:
Vault-scoped endpoint
{
  "url": "https://your-app.example.com/webhooks/casedev",
  "eventTypeFilters": ["vault.*"],
  "resourceScopes": {
    "vaultIds": ["vault_123"]
  }
}

Vault event types

Common vault events include:
EventDescription
vault.upload.initiatedA vault object upload was initiated.
vault.upload.completedA vault object upload finished successfully.
vault.upload.failedA vault object upload failed.
vault.ingest.startedVault object ingest started.
vault.ingest.completedVault object ingest finished successfully.
vault.ingest.failedVault object ingest failed.
The full generated reference, including payload fields, is available in Event types.

Delivery contract

Vault events use the same signed envelope as every Case.dev webhook:
{
  "id": "evt_01HV8ZK8M7Q9YJ6P5E3P2R1A0B",
  "type": "vault.ingest.completed",
  "occurred_at": "2026-04-24T15:12:09.481Z",
  "data": {
    "vaultId": "vault_123",
    "objectId": "obj_123",
    "durationMs": 1284,
    "chunkCount": 42
  }
}
Verify every delivery with the Case.dev signature headers before parsing the body. See the Events quickstart for Node and Python receiver examples.

Next steps

Events quickstart

Create an endpoint, send a test event, and verify the signature.

Event types

See generated event names, required scopes, and payload fields.

API reference

See the OpenAPI-generated reference for webhook endpoints and deliveries.