API Reference
Connect API
- Introduction
- Endpoints
Embedded API
- Introduction
- Endpoints
- Hubs
- End Users
- Connections
- Integrations
- Connectors
- Embed
- Activations
- Miscellaneous
Organisations API
- Overview
- Signing Keys
Retrieve an Activation
GetActivation returns the Activation for the given ID.
Path Parameters
Response
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.
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.
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.
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.
IsDeployed indicates whether the integration is deployed and available to end users. If not deployed, the integration cannot be activated.
Name is a short name for the integration, this is typically the name of the Connector being integrated to.
VariablesSchema is the JSON schema for the variables defined for this integration.
CreatedAt is the time the user was created.
DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.
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.
The hub ID to which the user belongs to.
ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.
PrimaryConnection is the connection that the user will use to authenticate to the primary connector.
CreatedAt is the time the Connection was created.
ConnectionCredentials defines the Action and Trigger credentials for the owning Connector. If multiple credentials are defined for each type, they are applied to the request in the order they are defined. This is to enable Connectors which require both a user session token and an API key to be provided in the request.
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.
CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.
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.
CredentialBase is the base type for all credentials. It contains the common properties which are shared across all credential types.
ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)
public-facing APIs will use the name in combination with the Connector's id instead.
Name is the name of the Connection. This must be unique within the owning Connector.
UpdatedAt is the time the Connection was last updated.
UpdatedAt is the time the user was last updated.