package
0.0.0-20220901125102-4d3dd682645a
Repository: https://github.com/mmussett/flogo-components.git
Documentation: pkg.go.dev

# README

WebSocket

This trigger provides your flogo application a websocket streaming connection to an endpoint

Installation

flogo install github.com/mmussett/flogo-components/trigger/websocket

Link for flogo web:

https://github.com/mmussett/flogo-components/trigger/websocket

Schema

Outputs and Endpoint:

{
"settings":[
    {
      "name": "url",
      "type": "string"
    }
  ],
  "outputs": [
    {
      "name": "event",
      "type": "string"
    }
  ],
  "handler": {
    "settings": [
      {
        "name": "handler_setting",
        "type": "string"
      }
    ]
}

Settings

SettingDescription
urlwebsocket url

Ouputs

OutputDescription
eventThe event data from the websocket server

Handlers

SettingDescription
N/Aawaiting better understanding

Example Configuration

Triggers are configured via the triggers.json of your application. The following is and example configuration of the WebSocket Trigger.

Read WebSocket Data

Configure the Trigger to receive websocket events

{
  "name": "websocket",
  "settings": {
		"url": "wss://localhost:4500/wsevents"
  },
  "handlers": [
    {
      "actionId": "local://testFlow2",
      "settings": {
        "handler_setting": "xxx"
      }
    }
  ]
}}

# Functions

NewFactory create a new Trigger factory.