Subscribe to the Beacon real-time notification stream
GET /beacon/v1/notifications
Operation id: subscribeNotifications
Description
Opens a long-lived Server-Sent Events connection that streams heartbeat, RSP, and WALK named events for the authenticated user's unit/domain. The response contains notification events filtered by the user's domain and unit context.
Authentication: domainId, userId, unitId, langCode, and upstream domainNo are resolved from the validated session (unitId ← session unit, domainNo ← String.valueOf(session.domainId)), matching the Angular SSE client. Query parameters are not accepted for unit/domain scope.
Named Events
| Event | Description |
|---|---|
heartbeat | Liveness ping. No meaningful data payload; only resets the client's watchdog timer. |
RSP | MyWork/feed domain event. data is a JSON object matching SseMessage. |
WALK | SWA walk/form domain event. data is a JSON object matching SseMessage. |
function Values
| SSE Event | function | Domain Area |
|---|---|---|
RSP | FEED | Feed/task list update |
RSP | RRCMESSAGE | Comments/message thread update |
RSP | BROADCASTMESSAGE | Broadcast message update |
WALK | WALKSCHEDULEINFO | Walk schedule/conduct update |
WALK | MODELSTATELISTING | Walk model-state update |
WALK | MODELSTATELISTING_FORM_TEMPLATE | Form template model-state update |
WALK | MODELSTATELISTING_FORM_INSTANCE | Form instance model-state update |
WALK | FORMMODEL | Form instance update |
WALK | FORMMODEL_TEMPLATE | Form template update |
Error Scenarios
| Scenario | HTTP | Error Code | Message |
|---|---|---|---|
Missing X-reflexis-csrf-token-X header | 400 | E112 | X-reflexis-csrf-token-X header is mandatory |
| Invalid or expired token | 401 | E204 | Invalid or expired token |
| Session has no unit id | 400 | E900 | unitId is mandatory |
| Upstream Beacon forbids unit/domain | 403 | E902 | Requested unitId/domainNo does not match the authenticated session |
| Upstream Beacon service rejects the forwarded token | 401 | E204 | Invalid or expired token |
| Upstream Beacon service unavailable or handshake failed | 500 | E903 | Beacon notification service is unavailable |
Error Codes Reference
| Code | Description |
|---|---|
E112 | X-reflexis-csrf-token-X header is mandatory |
E204 | Invalid or expired token |
E900 | Session unit id is missing (unitId is mandatory) |
E902 | Upstream rejected unit/domain context |
E903 | Beacon notification service is unavailable |
Tags: BeaconNotifications
Parameters
Header parameters
| Name | Type | Required | Description |
|---|---|---|---|
Accept | string | Yes | Must be text/event-stream. |
Security
- ApiKeyHeader (apiKey)
- APIGEE API key header validated by VerifyAPIKey policy.
- AuthTokenHeader (apiKey)
- Session authentication token validated server-side against the user session store.
Responses
200 — Success — a text/event-stream connection kept open indefinitely. Named events:
heartbeat (no payload), RSP/WALK (data is a JSON object matching SseMessage).
Content type: text/event-stream
400 — E112 header missing / E900 session unitId mandatory
Content type: application/json
401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)
Content type: application/json
403 — Requested unitId/domainNo does not match the authenticated session (HTTP 403)
Content type: application/json
500 — Unexpected server-side error
Content type: application/json
Response models
200 — Success — a text/event-stream connection kept open indefinitely. Named events:
heartbeat (no payload), RSP/WALK (data is a JSON object matching SseMessage).
Content type: text/event-stream
Schema
JSON payload carried in the data: field of RSP/WALK named SSE events. The client only reacts to function's presence; additional properties may be present and are not required to be consumed.
| Property | Type | Required | Description |
|---|---|---|---|
function | string | Yes | Discriminator identifying which domain change occurred. |
{
"type": "object",
"description": "JSON payload carried in the `data:` field of `RSP`/`WALK` named SSE events. The client\nonly reacts to `function`'s presence; additional properties may be present and are not\nrequired to be consumed.\n",
"required": [
"function"
],
"properties": {
"function": {
"type": "string",
"description": "Discriminator identifying which domain change occurred.",
"enum": [
"FEED",
"RRCMESSAGE",
"BROADCASTMESSAGE",
"WALKSCHEDULEINFO",
"MODELSTATELISTING",
"MODELSTATELISTING_FORM_TEMPLATE",
"MODELSTATELISTING_FORM_INSTANCE",
"FORMMODEL",
"FORMMODEL_TEMPLATE"
]
}
}
}
400 — E112 header missing / E900 session unitId mandatory
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E902) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E902)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E900",
"response": "unitId is mandatory"
}
401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E902) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E902)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
}
403 — Requested unitId/domainNo does not match the authenticated session (HTTP 403)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E902) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E902)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E902",
"response": "Requested unitId/domainNo does not match the authenticated session"
}
500 — Unexpected server-side error
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Always "ER" for error responses |
errorCode | string | Yes | Application-level error code (e.g. E204, E112, E902) |
response | string | Yes | Human-readable error message |
{
"type": "object",
"example": {
"status": "ER",
"errorCode": "E204",
"response": "Invalid or expired token"
},
"required": [
"status",
"errorCode",
"response"
],
"properties": {
"status": {
"type": "string",
"description": "Always \"ER\" for error responses",
"enum": [
"ER"
]
},
"errorCode": {
"type": "string",
"description": "Application-level error code (e.g. E204, E112, E902)"
},
"response": {
"type": "string",
"description": "Human-readable error message"
}
}
}
Example:
{
"status": "ER",
"errorCode": "E903",
"response": "Beacon notification service is unavailable"
}