Beacon
Version: 1.0.0 OpenAPI: 3.0.3
OpenAPI for the Beacon real-time notification stream (beacon/v1/...).
Same server base URL as MyWork, task execution, and legacy specs: /MYWORK/service/.
Authentication: All endpoints require the X-reflexis-csrf-token-X header.
Transport: GET /beacon/v1/notifications is a persistent Server-Sent Events (SSE) stream, not a single request/response call. The server validates the session, resolves unitId and domainNo from that session (not from query parameters), opens the connection to the upstream Beacon microservice, and proxies its heartbeat/RSP/WALK events back to the caller unchanged. Once the stream is open (HTTP 200, Content-Type: text/event-stream), errors are no longer expressed as JSON envelopes — the connection is simply closed and the client is expected to reconnect.
Companion specs: mywork/next-gen-mywork-api.yaml (application config, broadcasts, notes, recent tabs), task-execution/next-gen-task-execution-api.yaml (remaining task execution endpoints), walk-execution/next-gen-walk-execution-api.yaml (walk execution).
Servers
| URL | Description |
|---|---|
/MYWORK/service/ | Application context + Pulse servlet (typical deployment) |
https://fs3.reflexisinc.com/MYWORK/service/ | Example development host |
http://localhost:8080/MYWORK/service/ | Local Tomcat — app running directly on localhost:8080 |
http://localhost:3001/MYWORK/service/ | Local CORS proxy — npm run cors-proxy; path must include /MYWORK/service/ |
Security schemes
| Name | Type | Description |
|---|---|---|
AuthTokenHeader | apiKey | Session authentication token validated server-side against the user session store. |
Operations
Use the sidebar to browse individual operations generated from this specification.