Connect

Install socket.io-client and connect to your API origin. Set the transport path separately from the namespace:

import { io } from "socket.io-client";

const socket = io("https://api.photon.codes", {
  path: `/v1/projects/${projectId}/events/ws`,
  addTrailingSlash: false,
  transports: ["websocket"],
  extraHeaders: { Authorization: `Bearer ${apiKey}` },
  autoConnect: false,
});

Register your listeners before calling socket.connect(). Use the default namespace; the project path is the path option, not a namespace URL. The endpoint accepts the path with or without a trailing slash. You can omit addTrailingSlash: false to use the Socket.IO client’s default trailing slash. Your credential needs project:read for the selected project. Replies additionally require project:write. A browser cannot supply this authorization header on a websocket-only connection; the public integration targets Node.js and other clients that support handshake headers. Direct connections from customer browser applications are not supported. Polling and Socket.IO session recovery are disabled. See Start a session for subscription setup and Errors and reconnection for reconnect behavior.

Get started

Problems

Endpoints

Event Delivery WebSocket

Event schemas