agentux.events

Event subscription, unsubscription, and server-push notifications

← API Reference

agentux.events.subscribe

Subscribe to server-push event notifications on the current WebSocket connection.

Parameters:

Name Type Required Description
event_typesstring[]YesArray of event type names to subscribe to

Valid Event Types:

Event Type Notification Method Description
selectionChangedagentux.event.selectionChangedActor selection in the editor changed
assetSavedagentux.event.assetSavedA package/asset was saved
compilationCompleteagentux.event.compilationCompleteA Blueprint compilation completed
levelChangedagentux.event.levelChangedThe current level/map changed (load, save, new)

Returns:

Name Type Description
subscribedstring[]Event types successfully subscribed to
countnumberNumber of event types subscribed

Example Request:

{
  "jsonrpc": "2.0",
  "method": "agentux.events.subscribe",
  "params": {
    "event_types": ["selectionChanged", "assetSaved"]
  },
  "id": 1
}

Example Response:

{
  "jsonrpc": "2.0",
  "result": {
    "subscribed": ["selectionChanged", "assetSaved"],
    "count": 2
  },
  "id": 1
}

agentux.events.unsubscribe

Unsubscribe from one or more event types.

Parameters:

Name Type Required Description
event_typesstring[]YesArray of event type names to unsubscribe from

Returns:

Name Type Description
unsubscribedstring[]Event types unsubscribed from
countnumberNumber of event types unsubscribed

Example Request:

{
  "jsonrpc": "2.0",
  "method": "agentux.events.unsubscribe",
  "params": {
    "event_types": ["selectionChanged"]
  },
  "id": 2
}

Example Response:

{
  "jsonrpc": "2.0",
  "result": {
    "unsubscribed": ["selectionChanged"],
    "count": 1
  },
  "id": 2
}

agentux.events.list

List all available event types and current subscriptions.

No parameters.

Returns:

Name Type Description
availablestring[]All event types available for subscription
subscribedstring[]Event types currently subscribed to (across all connections)
subscriber_countnumberNumber of active WebSocket connections

Example Request:

{
  "jsonrpc": "2.0",
  "method": "agentux.events.list",
  "id": 3
}

Example Response:

{
  "jsonrpc": "2.0",
  "result": {
    "available": ["selectionChanged", "assetSaved", "compilationComplete", "levelChanged"],
    "subscribed": ["selectionChanged"],
    "subscriber_count": 1
  },
  "id": 3
}