Notifications SSE
Stream real-time clinical event notifications with Server-Sent Events (SSE) for medical findings, collaborator questions, and medical alerts.
Overview
This SSE endpoint streams real-time updates about clinical findings, collaborator questions, and alert notifications relevant to the ongoing medical session. It allows clients to receive asynchronous, event-driven notifications without polling.
Our SSE provides the following event types:
new_findings
Updated or new clinical findings infred from the Doctor-Patient conversation.
new_collaborator_question
Avey’s AI delivers precision-guided diagnostic questions to empower clinicians and boost diagnosis accuracy.
new_alerts
Receive medical adjudication alerts powered by Avey's state-of-the-art drug, procedure, and coding models.
Connection details
SSE endpoint URL
https://api.avey.ai/cowriter/v1/session/{session_id}/eventsHeaders
Accept: text/event-streamServer-Sent Events are unidirectional (server-to-client), providing an efficient way to stream updates without polling. For interaction requiring client-to-server messaging, consider complementary APIs.
Event payloads and structure
The SSE stream sends discrete events, each containing an event type and a JSON data payload, corresponding to one of the following schemas.
Event data models
| Event Name | Data Model |
|---|---|
new_findings | FindingEvent |
new_collaborator_question | CollaboratorQuestionEvent |
new_alerts | AlertEvent |
Data models
Finding Event
Prop
Type
Alert Event
Prop
Type
Collaborator Question Event
Prop
Type
Sample SSE event format
SSE messages follow the standard format with event and data fields.
event: new_findings
data: {
"findings": [
{
"status": "present",
"classification": "subjective",
"publisher": "maven",
"time": "2025-09-30T18:56:07.131157918Z",
"is_chief": true,
"concept": {
"id": "25064002",
"term": "Headache",
"coding": "snomed"
}
}
]
}Event flow diagram
How is this guide?