Skip to main content
POST
/
hubs
/
{hub_id}
/
integrations
Create Integration
curl --request POST \
  --url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "organisationId": "<string>",
  "connectionTemplate": {
    "authSchemeConfig": {
      "id": "<string>",
      "description": "<string>",
      "schemeType": "<string>",
      "validationMessages": [
        {
          "text": "<string>",
          "severity": "info",
          "detail": [
            "<string>"
          ]
        }
      ]
    },
    "connectorId": "<string>"
  },
  "description": "<string>",
  "summary": "<string>",
  "variablesSchema": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "boardId": "<string>",
  "imageUrl": "<string>",
  "screenshotUrl": "<string>",
  "description": "<string>",
  "variablesSchema": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
hub_id
string<ulid>
required

Body

application/json

IntegrationCreate contains the payload to create a new Embedded Integration.

​
name
string
required

The name of the Integration

​
organisationId
string<ulid>
required
​
connectionTemplate
object

CreateHubConnectionTemplate defines the request body for creating a new Hub Connector

​
description
string

Short description of the Integration

Example:

"My Integration to a shiny new service"

​
summary
string

The summary of the Integration

Example:

"My Integration to a shiny new service"

​
variablesSchema
object

VariablesSchema is the JSON schema for the variables defined for this integration.

Response

OK

Integration represents an embedded integration that can be activated by end users.

​
id
string<ulid>
required
​
name
string
required

Name is a short name for the integration, this is typically the name of the Connector being integrated to.

​
boardId
string<ulid>
required

BoardID is a reference to underlying board that configures the integration.

For more information on boards see Switchboard API.

​
imageUrl
string<uri>

ImageURL is a URL to an image/icon that represents the integration. This image is used within the integration tile displayed in the embedded UI.

​
screenshotUrl
string<uri>

ScreenshotURL is a PNG image/screenshot of the integration and can be used in the Hub Overview screen when displaying all integrations.

​
description
string

Description can be used to provide a longer description of the integration. This can be shown to end users in the embedded integration hub UI.

​
variablesSchema
object

VariablesSchema is the JSON schema for the variables defined for this integration.