WEBSOCKET API
Real-time bidirectional communication for instant updates
Instant, Reliable Updates
The Guardian-X WebSocket API provides real-time, bidirectional communication between clients and our servers, ensuring immediate delivery of critical updates.
When seconds matter, polling isn't fast enough. Our WebSocket infrastructure delivers situation updates, status changes, and alerts the moment they occur.
Sub-Second Delivery
Messages delivered in milliseconds, not seconds
Bidirectional
Send and receive on the same connection
Secure (WSS)
TLS-encrypted WebSocket connections
Real-Time Events
Subscribe to the events that matter to your integration
Situation Events
- Situation activated
- Situation updated
- Situation resolved
- All-clear issued
Status Events
- User status changed
- Check-in received
- Location updated
- Response submitted
Alert Events
- Duress activated
- Priority alert sent
- Broadcast message
- Acknowledgment received
Presence Events
- User online/offline
- Device connected
- Session started
- Connection quality
Message Events
- New message received
- Message read
- Typing indicator
- Thread updated
System Events
- Configuration changed
- Maintenance scheduled
- Service status
- Rate limit warnings
Technical Overview
The Guardian-X WebSocket API uses industry-standard protocols and patterns for reliable real-time communication.
Connection Flow
-
Authenticate
Obtain a session token via REST API
-
Connect
Establish WSS connection with token
-
Subscribe
Subscribe to relevant event channels
-
Receive & Send
Process incoming events, send messages
-
Maintain
Handle heartbeats and reconnection
WebSocket API Access
Complete WebSocket API documentation, including message schemas, event types, and client libraries, is available to Guardian-X customers.
Need WebSocket Access?
Contact our team to discuss your real-time integration requirements.
Contact Us