Skip to main content

Event Streams

Real-time changes from cases, applications, documents, records requests, and audit.

EventsAsyncAPI 3.0

Event streams tell partner systems the moment something changes, so nobody has to poll. Subscribe with the Events API, verify each delivery's signature, and fetch details from the producing API with your own scopes. Payloads carry identifiers only, never personal data.

AsyncAPI YAML Webhook guide

EVENT case.status_changed

A case moved to a new status.

Producer: Case Management API · Delivery: signed webhook (at least once) · Subscribe with: events:manage

Payload
{
  "eventId": "EVT-77311",
  "type": "case.status_changed",
  "occurredAt": "2026-09-30T14:22:05Z",
  "data": {
    "caseId": "CASE-2026-004817",
    "from": "received",
    "to": "in_review"
  }
}

EVENT case.note_added

A note was added to a case (content not included; fetch it with cases:read).

Producer: Case Management API · Delivery: signed webhook (at least once) · Subscribe with: events:manage

Payload
{
  "eventId": "EVT-77312",
  "type": "case.note_added",
  "occurredAt": "2026-09-30T15:01:10Z",
  "data": {
    "caseId": "CASE-2026-004817",
    "noteId": "NOTE-1180"
  }
}

EVENT application.submitted

A benefits or assistance application was received.

Producer: Applications API · Delivery: signed webhook (at least once) · Subscribe with: events:manage

Payload
{
  "eventId": "EVT-80100",
  "type": "application.submitted",
  "occurredAt": "2026-10-01T09:12:44Z",
  "data": {
    "applicationId": "APP-2026-118203",
    "program": "disaster_assistance"
  }
}

EVENT application.decided

An application was found eligible, ineligible, or awarded.

Producer: Applications API · Delivery: signed webhook (at least once) · Subscribe with: events:manage

Payload
{
  "eventId": "EVT-80166",
  "type": "application.decided",
  "occurredAt": "2026-10-02T16:40:00Z",
  "data": {
    "applicationId": "APP-2026-118203",
    "decision": "eligible"
  }
}

EVENT document.available

A document passed malware scanning and is ready to read.

Producer: Documents API · Delivery: signed webhook (at least once) · Subscribe with: events:manage

Payload
{
  "eventId": "EVT-80410",
  "type": "document.available",
  "occurredAt": "2026-10-01T09:13:02Z",
  "data": {
    "documentId": "DOC-55102",
    "caseId": "CASE-2026-004817"
  }
}

EVENT request.received

A FOIA or Privacy Act request was received.

Producer: Records Requests API · Delivery: signed webhook (at least once) · Subscribe with: events:manage

Payload
{
  "eventId": "EVT-81002",
  "type": "request.received",
  "occurredAt": "2026-10-01T11:00:00Z",
  "data": {
    "requestId": "FOIA-2026-000917",
    "track": "simple"
  }
}

EVENT request.released

A records request release package was published.

Producer: Records Requests API · Delivery: signed webhook (at least once) · Subscribe with: events:manage

Payload
{
  "eventId": "EVT-81055",
  "type": "request.released",
  "occurredAt": "2026-10-03T13:30:00Z",
  "data": {
    "requestId": "FOIA-2026-000917",
    "releaseId": "REL-3"
  }
}

EVENT audit.alert

An access pattern matched a security rule (for example bulk reads by one agent).

Producer: Audit Log API · Delivery: signed webhook (at least once) · Subscribe with: events:manage

Payload
{
  "eventId": "EVT-90001",
  "type": "audit.alert",
  "occurredAt": "2026-10-03T02:14:55Z",
  "data": {
    "rule": "bulk_read",
    "actor": "agent:case-summary",
    "count": 412
  }
}