/  Yamcs HTTP API  /  Events  /  Subscribe Events

Subscribe EventsΒΆ

Receive event updates

WebSocket

This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.

Use the message type events.

Input Type

interface SubscribeEventsRequest {
  instance: string;
}

Output Type

interface Event {
  source: string;
  generationTime: string;  // RFC 3339
  receptionTime: string;  // RFC 3339
  seqNumber: number;
  type: string;
  message: string;
  severity: EventSeverity;
  generationTimeUTC: string;
  receptionTimeUTC: string;

  // Set by API when event was posted by a user
  createdBy: string;
}

Related Types

enum EventSeverity {
  INFO = "INFO",
  WARNING = "WARNING",
  ERROR = "ERROR",

  //the levels below are compatible with XTCE
  // we left the 4 out since it could be used
  // for warning if we ever decide to get rid of the old ones
  WATCH = "WATCH",
  DISTRESS = "DISTRESS",
  CRITICAL = "CRITICAL",
  SEVERE = "SEVERE",
}