validateIntegrationCreation

Perform a validation of an integration creation request

POST /v1/admin/integrations/validate

Try it

cURL

cURL

curl --request POST \
  --url https://api.botpress.cloud/v1/admin/integrations/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "name": "<string>",
  "version": "<string>",
  "configuration": {
    "title": "<string>",
    "description": "<string>",
    "schema": {},
    "identifier": {
      "required": true,
      "linkTemplateScript": "<string>"
    }
  },
  "configurations": {},
  "states": {},
  "events": {},
  "actions": {},
  "entities": {},
  "attributes": {},
  "identifier": {
    "fallbackHandlerScript": "<string>",
    "extractScript": "<string>"
  },
  "channels": {},
  "user": {
    "creation": {
      "enabled": true,
      "requiredTags": [
        "<string>"
      ]
    },
    "tags": {}
  },
  "interfaces": {},
  "extraOperations": {},
  "secrets": {},
  "code": "<string>",
  "url": "<string>",
  "dev": true,
  "icon": "<string>",
  "readme": "<string>",
  "title": "<string>",
  "description": "<string>",
  "public": true,
  "visibility": "public",
  "layers": [
    "<string>"
  ]
}
'

200

{}

Authorizations

Authorization · string · header · required

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

Headers

x-workspace-id · string · required

Workspace ID

x-multiple-integrations · string

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.

Body

application/json

Integration

name · string · required

Name of the Integration

Maximum string length: 200

version · string · required

Version of the Integration

Maximum string length: 200

configuration · object

Default configuration definition of the integration

Show child attributes

configuration. title · string

Title of the configuration

Maximum string length: 64

configuration. description · string

Description of the configuration

Maximum string length: 256

configuration. schema · object

Schema of the configuration in the JSON schema format. The configuration data is validated against this JSON schema.

configuration. identifier · object

Show child attributes

configuration.identifier. required · boolean

configuration.identifier. linkTemplateScript · string

Maximum string length: 2000

configurations · object

Additional configuration definitions of the integration

Show child attributes

configurations. {key} · object

Show child attributes

configurations.{key}. title · string

Title of the configuration

Maximum string length: 64

configurations.{key}. description · string

Description of the configuration

Maximum string length: 256

configurations.{key}. schema · object

Schema of the configuration in the JSON schema format. The configuration data is validated against this JSON schema.

configurations.{key}. identifier · object

Show child attributes

configurations.{key}.identifier. required · boolean

configurations.{key}.identifier. linkTemplateScript · string

Maximum string length: 2000

states · object

Show child attributes

states. {key} · object

State definition

Show child attributes

states.{key}. type · enum<string> · required

Type of the State (conversation, user or integration)

Available options: conversation, user, integration

states.{key}. schema · object · required

Schema of the State in the JSON schema format. This JSON schema is going to be used for validating the state data.

events · object

Show child attributes

events. {key} · object

Event Definition

Show child attributes

events.{key}. schema · object · required

events.{key}. title · string

Title of the event

Maximum string length: 64

events.{key}. description · string

Description of the event

Maximum string length: 256

events.{key}. attributes · object

Optional attributes

Show child attributes

events.{key}.attributes. {key} · string

Maximum string length: 200

actions · object

Show child attributes

actions. {key} · object

Action definition

Show child attributes

actions.{key}. input · object · required

Show child attributes

actions.{key}.input. schema · object · required

actions.{key}. output · object · required

Show child attributes

actions.{key}.output. schema · object · required

actions.{key}. title · string

Title of the action

Maximum string length: 64

actions.{key}. description · string

Description of the action

Maximum string length: 256

actions.{key}. billable · boolean

actions.{key}. cacheable · boolean

actions.{key}. attributes · object

Optional attributes

Show child attributes

actions.{key}.attributes. {key} · string

Maximum string length: 200

entities · object

Show child attributes

entities. {key} · object

Entity definition

Show child attributes

entities.{key}. schema · object · required

entities.{key}. title · string

Title of the entity

Maximum string length: 64

entities.{key}. description · string

Description of the entity

Maximum string length: 256

attributes · object

Optional attributes

Show child attributes

attributes. {key} · string

Maximum string length: 200

identifier · object

Show child attributes

identifier. fallbackHandlerScript · string

Maximum string length: 2000

identifier. extractScript · string

Maximum string length: 2000

channels · object

Show child attributes

channels. {key} · object

Show child attributes

channels.{key}. messages · object · required

Show child attributes

channels.{key}.messages. {key} · object

Message definition

Show child attributes

channels.{key}.messages.{key}. schema · object · required

channels.{key}. title · string

Title of the channel

Maximum string length: 64

channels.{key}. description · string

Description of the channel

Maximum string length: 256

channels.{key}. conversation · object

Show child attributes

channels.{key}.conversation. creation · object

The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the createConversation functionality to support this setting.

Show child attributes

channels.{key}.conversation.creation. enabled · boolean · required

Enable conversation creation

channels.{key}.conversation.creation. requiredTags · string[] · required

The list of tags that are required to be specified when calling the API directly to create a conversation.

channels.{key}.conversation. tags · object

Show child attributes

channels.{key}.conversation.tags. {key} · object

Definition of a tag that can be provided on the object

Show child attributes

channels.{key}.conversation.tags.{key}. title · string

Title of the tag

Maximum string length: 64

channels.{key}.conversation.tags.{key}. description · string

Description of the tag

Maximum string length: 256

channels.{key}. message · object

Show child attributes

channels.{key}.message. tags · object

Show child attributes

channels.{key}.message.tags. {key} · object

Definition of a tag that can be provided on the object

Show child attributes

channels.{key}.message.tags.{key}. title · string

Title of the tag

Maximum string length: 64

channels.{key}.message.tags.{key}. description · string

Description of the tag

Maximum string length: 256

user · object

Show child attributes

user. creation · object

The user creation setting determines how to create a user through the API directly. The integration will have to implement the createUser functionality to support this setting.

Show child attributes

user.creation. enabled · boolean · required

Enable user creation

user.creation. requiredTags · string[] · required

The list of tags that are required to be specified when calling the API directly to create a user.

user. tags · object

Show child attributes

user.tags. {key} · object

Definition of a tag that can be provided on the object

Show child attributes

user.tags.{key}. title · string

Title of the tag

Maximum string length: 64

user.tags.{key}. description · string

Description of the tag

Maximum string length: 256

interfaces · object

Show child attributes

interfaces. {key} · object

Show child attributes

interfaces.{key}. id · string · required

ID of the interface

Required string length: 28 - 36

interfaces.{key}. entities · object

Show child attributes

interfaces.{key}.entities. {key} · object

Show child attributes

interfaces.{key}.entities.{key}. name · string · required

Maximum string length: 200

interfaces.{key}. actions · object

Show child attributes

interfaces.{key}.actions. {key} · object

Show child attributes

interfaces.{key}.actions.{key}. name · string · required

Maximum string length: 200

interfaces.{key}. events · object

Show child attributes

interfaces.{key}.events. {key} · object

Show child attributes

interfaces.{key}.events.{key}. name · string · required

Maximum string length: 200

interfaces.{key}. channels · object

Show child attributes

interfaces.{key}.channels. {key} · object

Show child attributes

interfaces.{key}.channels.{key}. name · string · required

Maximum string length: 200

extraOperations · object

EXPERIMENTAL Extra integration operations that should be sent or not to the integration instances. The key is the operation name.

Show child attributes

extraOperations. {key} · object

Show child attributes

extraOperations.{key}. enabled · boolean · required

secrets · object

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.

Show child attributes

secrets. {key} · string | null

Maximum string length: 20000

code · string

JavaScript code of the integration

url · string

URL of the integration

dev · boolean

Indicates if the integration is a development integration; Dev integrations run locally

icon · string

Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.

readme · string

Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.

title · string

Title of the integration. This is the name that will be displayed in the UI

Required string length: 1 - 64

description · string

Description of the integration. This is the description that will be displayed in the UI

Maximum string length: 256

public · boolean · deprecated

[DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.

visibility · enum<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

layers · string[]

Response

200

application/json

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

The response is of type validateIntegrationCreationResponse · object.