Create a Hub Connector
CreateHubConnectionTemplate creates a new Hub Connector for the given Integration.
A Hub Connector is a lightweight wrapper around a Connector from Connect API, but includes additional information to make embedding the integration simpler:
- A name/reference for the Hub Connector, which represents the purpose of the Connector in the context of the Hub’s Integration. For example, where an Integration is synchronising data between two accounts of the same system, each Hub Connector may be referenced, “Source” and “Target”, even though they are both referencing the same underlying Connector.
- Which
AuthSchemeConfigto use, so that when the end user activates the integration, they are prompted to authenticate in the correct way.
Path Parameters
Body
CreateHubConnectionTemplate defines the request body for creating a new Hub Connector
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.
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.
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.
"none"ConnectorID is the unique identifier of the Connector that the Hub Connector is wrapping.
Response
A Hub Connection Template is a lightweight wrapper around a Connector from Connect API, but includes additional information to make embedding the integration simpler.
Versori-users do not need to establish connections in an integration. These are connected to by end-users when they activate the integration from the embedded integration hub.
ID is the unique identifier of the Hub Connection Template.
ConnectorID is the unique identifier of the Connector.
ImageURL is a URL to an image/icon that represents the connector. This image is used within the integration tile displayed in the embedded UI.
name denotes the name of the Connector that the template is wrapping.
IsUsed indicates that this connection template is in use by the hub.
IsPrimary indicates that this is the primary connections on the hub.
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.
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.
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.
"none"