POST
/
activations

Body

application/json

ActivationCreate is the request payload to activate an Integration for End User

userId
string
required

UserID references the user to activate the integration for, this may be their Versori identifier or their external identifier, indicated by the userIdType field.

integrationId
string
required

IntegrationID references the Integration that the activation is for.

connections
object[]
required

Connections is a list of Activation Connections to create for this Activation. Each Activation Connection can either reference an existing underlying Connection, or a new Connection can be created.

connections.templateId
string
required

TemplateID is a reference to a Connection Template which this Activation Connection is binding to.

connections.connectionId
string
required

ID is the unique identifier of an existing Connection.

dynamicVariables
object

Dynamic variables can be used on an integration at run time. The user specifies the value of these variables when activating an integration. When an integration is created, the name and types of these variables can be defined.

Response

200 - application/json
id
string
required
user
object
required
user.id
string
required

ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.

user.externalId
string
required

ExternalID is the identifier for the user as determined by the organisation. This typically should be the same as the user's ID on the Primary Connector for the Hub. Regardless of the value, it must be unique within the Hub.

user.displayName
string
required

DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.

user.hubId
string
required

The hub ID to which the user belongs to.

user.primaryConnection
object
required

PrimaryConnection is the connection that the user will use to authenticate to the primary connector.

user.createdAt
string
required

CreatedAt is the time the user was created.

user.updatedAt
string
required

UpdatedAt is the time the user was last updated.

hubId
string
required
integration
object
required

EndUserIntegration represents an integration that is available to an end user.

This object is only a summary of the integration and does not contain all the information to enable the user to activate it. The GetEmbeddedIntegration endpoint should be used to retrieve the full integration details.

integration.id
string
required
integration.name
string
required

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

integration.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.

integration.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.

integration.isDeployed
boolean
required

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

integration.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.

integration.variablesSchema
object

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

List End User ActivationsRetrieve an Activation