socketbox

Implement real-time WebSocket features in ColdBox using SocketBox.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/ColdBox/skills --skill socketbox
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: socketbox
Source: https://github.com/ColdBox/skills/tree/main/modules/socketbox
Command: npx skills add https://github.com/ColdBox/skills --skill socketbox

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables developers to implement real-time WebSocket features in ColdBox using SocketBox, covering event handlers, room broadcasting, client-side integration, and production patterns.

Core Features & Use Cases

  • Event-driven WebSocket handling (onConnect, onDisconnect, onMessage)
  • Room-based broadcasting and per-socket messaging
  • Client-side integration examples and production patterns
  • Authentication on connect and secure messaging patterns

Quick Start

Install the socketbox module and begin building real-time WebSocket features in ColdBox.

Frequently Asked Questions about socketbox

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build real-time WebSocket apps with ColdBox?

ColdBox uses SocketBox to implement real-time WebSocket features by handling onConnect, onMessage, and onDisconnect events. It supports room-based broadcasting and per-socket messaging for live chat and dashboard applications.

What is the best way to broadcast WebSocket events to specific rooms in ColdBox?

SocketBox provides room-based broadcasting patterns in ColdBox to target specific groups of connected sockets. This approach enables secure, per-room messaging for real-time interactions without broadcasting to all connected clients.

Can I authenticate WebSocket connections on connect in ColdBox?

SocketBox supports authentication on connect within ColdBox applications. You validate users directly inside the onConnect handler to establish secure WebSocket connections and enforce safe messaging patterns before the session proceeds.

Do I need a specific environment to run real-time WebSocket features in ColdBox?

Yes, implementing real-time WebSocket features requires a ColdBox environment and familiarity with the SocketBox API, specifically onConnect, onMessage, and onDisconnect handlers, alongside room broadcasting patterns for production use.

How do I handle client-side integration for WebSocket events in a ColdBox application?

SocketBox provides client-side integration examples and production patterns for ColdBox applications. You connect frontend clients to backend WebSocket handlers to receive real-time messages and room broadcasts across the application.