POST
/
hubs
/
{hub_id}
/
integrations

Path Parameters

​
hub_id
string
required

Body

application/json

IntegrationCreate contains the payload to create a new Embedded Integration.

​
name
string
required

The name of the Integration

​
organisationId
string
required
​
connectionTemplate
object

CreateHubConnectionTemplate defines the request body for creating a new Hub Connector

​
connectionTemplate.authSchemeConfig
object
required

AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its authentication requirements. This is purely the configuration and not the actual credential which is used to authenticate. The credential uses this configuration to determine how to authenticate.

​
connectionTemplate.connectorId
string
required

ConnectorID is the unique identifier of the Connector that the Hub Connector is wrapping.

​
description
string

Short description of the Integration

​
summary
string

The summary of the Integration

​
variablesSchema
object

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

Response

200 - application/json

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

​
id
string
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
required

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

For more information on boards see Switchboard API.

​
imageUrl
string

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

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.

Retrieve a HubUpdate integration information