Events

Events are useful when a GUI client wants to receive updates as soon as they arrive to the manager. Events are send over websockets and are preferred over short polling.

The websocket is exposed at /events endpoint. The client subscribes to all events, except when the list of events is passed in topics query parameter. E.g. /events?topics=event1,event2,...

The following events are available:

• logs (plural) - additionally supporting target and task queries
• targetAdded
• targetUpdated

Plural events use the following format:

{
  "topic": "<eventTopic>",
  "payload": []
}

where payload is an array of objects of the expected event type.

Singular events follow:

{
  "topic": "<eventTopic>",
  "payload": {}
}

where payload is the event object.