AlphornAlphorn Docs

Stream notifications (SSE)

GET /api/stream/{publicId}: receive Alphorn notifications in real time over Server-Sent Events. Event format, connection limits, and errors.

GET
/api/stream/{publicId}

Opens a Server-Sent Events stream for a Live Stream channel. Every notification routed to the channel arrives as an event. The server sends a : connected comment right away and a : keepalive comment every 30 seconds. No authentication: the channel's stream ID is the secret.

Path Parameters

publicId*string

The Live Stream channel's stream ID.

Response Body

Event stream. With the channel's JSON output format, each data: line is a JSON StreamEvent (x-event-data); with the text format, a single line of fields separated by |.

response?stringtext/event-stream
curl -X GET 'https://app.alphorn.dev/api/stream/string'
"string"