WebSockets

Temba can automatically broadcast data changes to connected clients via WebSockets.

To enable WebSocket support:

const config = {
  webSocket: true,
}

Once enabled, the WebSocket server is available at the same host and port as your API, using the /ws path, for example: ws://localhost:8362/ws

Once connected, whenever a resource is changed via a POST, PUT, PATCH, or DELETE request a message will be sent.

The broadcast message is a JSON object containing the name of the resource, the type of change ("CREATE", "UPDATE", "DELETE", or "DELETE_ALL"), and the updated resource object:

{
  "resource": "movies",
  "action": "CREATE",
  "data": {
    "id": "123",
    "title": "O Brother, Where Art Thou?",
    "description": "In the deep south..."
  }
}

For a single deletion (e.g., DELETE /movies/123), the data object contains only the ID of the deleted item:

{
  "resource": "movies",
  "action": "DELETE",
  "data": { "id": "123" }
}

For a collection deletion (e.g., DELETE /movies), the action is "DELETE_ALL" and the data property is omitted entirely:

{
  "resource": "movies",
  "action": "DELETE_ALL"
}