Fumadocs

Subscribe to Planet Events

Receive
/planets/{planetId}/events
Server

Subscribe to real-time events for a specific planet

Real-time events related to specific planets. Subscribe to get notified about:

  • Planet creation and updates
  • Atmospheric changes
  • Discovery of new satellites
  • Cosmic events (explosions, collisions, etc.)
  • Image uploads and media updates

Authorization

headerAuthorizationBearer <JWT>

JWT Bearer token authentication for WebSocket connections

Address Parameters

planetId*string

The ID of the planet

Query Parameters

includeHistory?boolean

Include historical events

Defaultfalse
eventTypes?array<string>

Filter by specific event types

Code Sample
const socket = new WebSocket("wss://galaxy.scalar.com/planets/{planetId}/events?api_key=YOUR_API_KEY");

socket.addEventListener("message", (event) => {
  console.log(event.data);
});

Messages