@restackio/integrations-websocket

This package provides WebSocket integration for Restack, allowing you to easily incorporate WebSocket functionality into your Restack workflows.

Installation

To install the package

npm install @restackio/integrations-websocket

Usage

Importing the Service

To use the WebSocket service in your Restack application, import it as follows:

// services.ts
import Restack from "@restackio/ai";
import { websocketService } from "@restackio/integrations-websocket";

export async function services() {
  const client = new Restack();
  websocketService({ client }).catch((err) => {
    console.error("Error starting Websocket service:", err);
  });
}

services().catch((err) => {
  console.error("Error running services:", err);
});

Available Functions

This package provides two main functions:

1. websocketListen: Listens for WebSocket events and triggers corresponding workflow events.
2. websocketSend: Sends events through a WebSocket connection.

websocketListen

websocketListen({
  streamSid: string,
  events?: {
  websocketEventName: string,
  workflowEventName: string,
  workflow?: SendWorkflowEvent["workflow"]
  }[],
  address?: string
})

websocketSend

websocketSend({
  name: string,
  input: WebsocketEvent,
  address: string,
});