GET
/
embed
/
{hub_id}
/
users
/
{user_id}
/
integrations

Path Parameters

​
hub_id
string
required
​
user_id
string
required

UserID references an End User in the Hub.

Most APIs support setting this value to either the internal Versori identifier or their external ID as determined by the organisation. The identifier_type query parameter is used to indicate which type of ID is being used.

Query Parameters

​
identifier_type
enum<string>
default: external

IdentifierType indicates whether the user_id path parameter is a internal identifier created by Versori, or an external identifier. If the value is external, some endpoints also require the hub query parameter to identify the correct Hub.

Available options:
internal,
external
​
deployed
boolean

Deployed allowing filtering integrations to only return either deployed (true) or not deployed (false) integrations.

If not set, all integrations are returned.

Response

200 - application/json

EndUserIntegrationPage is a paginated list of integrations to be displayed to the user when embedding the integration hub.

​
totalCount
integer
required
​
integrations
object[]
required
​
integrations.id
string
required
​
integrations.name
string
required

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

​
integrations.imageUrl
string
required

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.

​
integrations.description
string
required

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.

​
integrations.variablesSchema
object

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

​
integrations.isDeployed
boolean
required

IsDeployed indicates whether the integration is deployed and available to end users. If not deployed, the integration cannot be activated.

​
integrations.isActivated
boolean
required

IsActivated indicates whether the integration is activated for the end user. If the integration is not activated, the user can activate it from the embedded integration hub.

​
next
string
​
prev
string
​
totalConnected
integer

TotalConnected is the total number of integrations that are connected for the end user. This can be used to display a badge on the embedded integration hub to show the user how many integrations they have connected.

Create a Hub ConnectorRetrieve an Embedded Integration