Skip to content
hypeman
Get started
API Reference
Builds

Stream build events (SSE)

get/builds/{id}/events

Streams build events as Server-Sent Events. Events include:

  • log: Build log lines with timestamp and content
  • status: Build status changes (queued→building→pushing→ready/failed)
  • heartbeat: Keep-alive events sent every 30s to prevent connection timeouts

Returns existing logs as events, then continues streaming if follow=true.

Path ParametersExpand Collapse
id: string
Query ParametersExpand Collapse
follow: optional boolean

Continue streaming new events after initial output

ReturnsExpand Collapse
BuildEvent = object { timestamp, type, content, status }
timestamp: string

Event timestamp

formatdate-time
type: "log" or "status" or "heartbeat"

Event type

Accepts one of the following:
"log"
"status"
"heartbeat"
content: optional string

Log line content (only for type=log)

status: optional BuildStatus

New build status (only for type=status)

Accepts one of the following:
"queued"
"building"
"pushing"
"ready"
"failed"
"cancelled"
Stream build events (SSE)
curl http://localhost:8080/builds/$ID/events \
    -H "Authorization: Bearer $HYPEMAN_API_KEY"
Returns Examples