Skip to main content

Admin Socket.IO Gateway

The createAdminGateway() function attaches admin CRUD event handlers to a Socket.IO server. All operations use acknowledgement callbacks for request-response, and mutations are broadcast to all connected clients in real time.

Setup


AdminGatewayOptions

Server
required
Socket.IO server instance.
StorageDriver
required
Storage backend for persisting blueprints.
Record<string, ToolDef>
Named tools available for agent creation. Explicit entries override toolkit tools.
Toolkit[]
Toolkit instances whose tools are automatically collected into the tool library.
string
default:"/agentium-admin"
Socket.IO namespace for admin events.
(socket, next) => void
Socket.IO middleware for authentication.

Events

Agent Events

Team Events

Workflow Events

Tools

Toolkit Catalog

Toolkit Configs (Credentials)

Registry


Broadcast Events

When entities are created, updated, or deleted, the gateway broadcasts to all connected clients on the admin namespace: This enables real-time UI updates — when one user creates an agent, all other connected users see it appear immediately.

Client Example


Full Flow: Create Agents, Build Team, Run