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": {}
}Create Integration
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
IntegrationCreate contains the payload to create a new Embedded Integration.
The name of the Integration
CreateHubConnectionTemplate defines the request body for creating a new Hub Connector
Show child attributes
Show child attributes
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.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and only requires to be unique amongst the elements of the array in which is it contained.
Description enables users to distinguish multiple configurations which use the same schemeType.
"none"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig is validated. This is typically used to provide feedback to the user when they are creating or updating the AuthSchemeConfig.
This field will be ignored if sent to the API.
Show child attributes
Show child attributes
Text contains the text of the message.
info, warning, error Details contains additional information about the message. This is intended to be used to provide more information about the message, such as a list of validation errors.
ConnectorID is the unique identifier of the Connector that the Hub Connector is wrapping.
Short description of the Integration
The summary of the Integration
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.
Name is a short name for the integration, this is typically the name of the Connector being integrated to.
BoardID is a reference to underlying board that configures the integration.
For more information on boards see Switchboard API.
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 is a PNG image/screenshot of the integration and can be used in the Hub Overview screen when displaying all integrations.
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 is the JSON schema for the variables defined for this integration.