Connio

The Connio API Developer Hub

Welcome to the Connio API developer hub. You'll find comprehensive guides and documentation to help you start working with Connio API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

WebSocket

WebSocket data connector configuration object consists of the following attributes:

AttributeDescription
typeConnector type; must be always set to ws.
idApp wide unique connector id.
serverProvide only the domain part of the URL without scheme.
portService port number.
sslEither true or false. If true wss scheme is used instead of .
pathOptional. Subdirectory part of the URL.
headersOptional Custom HTTP headers. User can add up to 10 headers.
credentialsOptional Basic authentication credentials object. Consists of user and password fields.
dataProcessingMethodOptional. Id or name of the App method that will be used for filtering and/or transforming incoming data. See Overview page for details.
disabledOptional. When true data connector stops streaming.
POST .../v3/apps/:ref/dataconnectors/test

{
  "type": "ws",
  "id": "dc.ws.1",
  "server": "echo.kaazing.com",
  "port": 443,
  "ssl": true,
  "path": "/echo",
  "disabled": false
}
POST .../v3/apps/:ref/dataconnectors

{
  "type": "ws",
  "id": "dc.ws.1",
  "server": "echo.kaazing.com",
  "port": 443,
  "ssl": true,
  "path": "/echo",
  "dataProcessingMethod": "_mtd_695058884056880409",
  "disabled": false
}
PUT .../v3/apps/:ref/dataconnectors/dc.ws.1

{
  "dataProcessingMethod": "processWSData"
}

Updated 5 months ago


What's Next

AMQP

WebSocket


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.