validateIntegrationUpdate

Perform a validation of an integration update request

PUT /v1/admin/integrations/{id}/validate

cURL

cURL

curl --request PUT \
  --url https://api.botpress.cloud/v1/admin/integrations/{id}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "configuration": {
    "title": "<string>",
    "description": "<string>",
    "schema": {},
    "identifier": {
      "linkTemplateScript": "<string>",
      "required": true
    }
  },
  "configurations": {},
  "extraOperations": {},
  "sdkVersion": "<string>",
  "channels": {},
  "maxExecutionTime": 123,
  "identifier": {
    "extractScript": "<string>",
    "fallbackHandlerScript": "<string>"
  },
  "actions": {},
  "events": {},
  "states": {},
  "user": {
    "tags": {}
  },
  "entities": {},
  "interfaces": {},
  "attributes": {},
  "secrets": {},
  "code": "<string>",
  "icon": "<string>",
  "readme": "<string>",
  "title": "<string>",
  "description": "<string>",
  "url": "<string>",
  "public": true,
  "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.

Path Parameters

id · string · required

Integration Version ID

Body

application/json

Integration

configuration · object

Default configuration definition of the integration

Show child attributes

configurations · object

Additional configuration definitions of the integration

Show child attributes

extraOperations · object

EXPERIMENTAL extra integration operations enabled for this integration. Keys map to operation names. A value of null or { enabled: false } removes the operation; { enabled: true } enables it. Operations that are not provided are left unchanged.

Show child attributes

sdkVersion · string

Maximum string length: 200

channels · object

Show child attributes

maxExecutionTime · integer

Maximum execution time of the integration (in seconds).

identifier · object

Show child attributes

actions · object

Show child attributes

events · object

Show child attributes

states · object

Show child attributes

user · object

Show child attributes

entities · object

Show child attributes

interfaces · object

Show child attributes

attributes · object

Optional key-value attributes. Set attributes to null to remove them

Show child attributes

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

code · string

JavaScript code of the integration

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

url · string | null

URL of the integration

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 updated using the same parameters

The response is of type validateIntegrationUpdateResponse · object.