Docs

validateIntegrationCreation

Perform a validation of an integration creation request

POST/v1/admin/integrations/validate

Authorization

AuthorizationBearerrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-workspace-idstringrequired
Workspace ID
x-multiple-integrationsstring
Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.

Request body

Integration

namestringrequired
Name of the Integration(max length: 200)
versionstringrequired
Version of the Integration(max length: 200)
configurationobject
Default configuration definition of the integration
configurationsobject
Additional configuration definitions of the integration
statesobject
eventsobject
actionsobject
entitiesobject
attributesobject
Optional attributes
identifierobject
channelsobject
userobject
interfacesobject
extraOperationsobject
**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
sdkVersionstring
(max length: 200)
secretsobject
Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
codestring
JavaScript code of the integration
urlstring
URL of the integration
devboolean
Indicates if the integration is a development integration; Dev integrations run locally
iconstring
Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
readmestring
Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.
titlestring
Title of the integration. This is the name that will be displayed in the UI(min length: 1, max length: 64)
descriptionstring
Description of the integration. This is the description that will be displayed in the UI(max length: 256)
publicbooleandeprecated
[DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
visibilityenum<string>
The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
Available options:"public","private","unlisted"
layersstring[]

Response

Validation succeeded: the integration can be created using the same parameters