updateIntegration

PUT

admin

integrations

{id}

curl --request PUT \
  --url https://api.botpress.cloud/v1/admin/integrations/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "configuration": {
    "title": "<string>",
    "description": "<string>",
    "schema": {},
    "identifier": {
      "linkTemplateScript": "<string>",
      "required": true
    }
  },
  "configurations": {},
  "channels": {},
  "identifier": {
    "extractScript": "<string>",
    "fallbackHandlerScript": "<string>"
  },
  "actions": {},
  "events": {},
  "states": {},
  "user": {
    "creation": {
      "enabled": true,
      "requiredTags": [
        "<string>"
      ]
    },
    "tags": {}
  },
  "entities": {},
  "interfaces": {},
  "sandbox": {
    "identifierExtractScript": "<string>",
    "messageExtractScript": "<string>"
  },
  "secrets": {},
  "code": "<string>",
  "icon": "<string>",
  "readme": "<string>",
  "title": "<string>",
  "description": "<string>",
  "url": "<string>",
  "public": true,
  "layers": [
    "<string>"
  ]
}'

{
  "integration": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "identifier": {
      "fallbackHandlerScript": "<string>",
      "extractScript": "<string>"
    },
    "sandbox": {
      "identifierExtractScript": "<string>",
      "messageExtractScript": "<string>"
    },
    "url": "<string>",
    "name": "<string>",
    "version": "<string>",
    "interfaces": {},
    "configuration": {
      "title": "<string>",
      "description": "<string>",
      "identifier": {
        "linkTemplateScript": "<string>",
        "required": true
      },
      "schema": {}
    },
    "configurations": {},
    "channels": {},
    "states": {},
    "events": {},
    "actions": {},
    "user": {
      "tags": {},
      "creation": {
        "enabled": true,
        "requiredTags": [
          "<string>"
        ]
      }
    },
    "entities": {},
    "dev": true,
    "title": "<string>",
    "description": "<string>",
    "iconUrl": "<string>",
    "readmeUrl": "<string>",
    "public": true,
    "verificationStatus": "unapproved",
    "secrets": [
      "<string>"
    ]
  }
}

Path Parameters

string

required

Integration Version ID

Body

application/json

Integration

configuration

object

Default configuration definition of the integration

configurations

object

Additional configuration definitions of the integration

channels

object

identifier

object

actions

object

events

object

states

object

user

object

entities

object

interfaces

object

sandbox

object

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.

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 length: 256

url

string | null

URL of the integration

public

boolean

Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.

layers

string[]

Response

200

application/json

Success

integration

object

required

integration.id

string

required

ID of the Integration

Required string length: 28 - 36

integration.createdAt

string

required

Creation date of the Integration in ISO 8601 format

integration.updatedAt

string

required

Updating date of the Integration in ISO 8601 format

integration.identifier

object

required

Global identifier configuration of the Integration

integration.url

string

required

URL of the Integration

Maximum length: 2000

integration.name

string

required

Name of the Integration

Maximum length: 200

integration.version

string

required

Version of the Integration

Maximum length: 200

integration.interfaces

object

required

integration.configuration

object

required

Configuration definition

integration.configurations

object

required

integration.channels

object

required

integration.states

object

required

integration.events

object

required

integration.actions

object

required

integration.user

object

required

User object configuration

integration.entities

object

required

integration.dev

boolean

required

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

integration.title

string

required

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

Required string length: 1 - 64

integration.description

string

required

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

Maximum length: 256

integration.iconUrl

string

required

URL of the icon of the integration. This is the icon that will be displayed in the UI

integration.readmeUrl

string

required

URL of the readme of the integration. This is the readme that will be displayed in the UI

integration.public

boolean

required

Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.

integration.verificationStatus

enum<string>

required

Status of the integration version verification

Available options:

unapproved,

pending,

approved,

rejected

integration.secrets

string[]

required

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.

integration.sandbox

object

Was this page helpful?

Suggest edits Raise issue

validateIntegrationCreation getIntegration

curl --request PUT \
  --url https://api.botpress.cloud/v1/admin/integrations/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "configuration": {
    "title": "<string>",
    "description": "<string>",
    "schema": {},
    "identifier": {
      "linkTemplateScript": "<string>",
      "required": true
    }
  },
  "configurations": {},
  "channels": {},
  "identifier": {
    "extractScript": "<string>",
    "fallbackHandlerScript": "<string>"
  },
  "actions": {},
  "events": {},
  "states": {},
  "user": {
    "creation": {
      "enabled": true,
      "requiredTags": [
        "<string>"
      ]
    },
    "tags": {}
  },
  "entities": {},
  "interfaces": {},
  "sandbox": {
    "identifierExtractScript": "<string>",
    "messageExtractScript": "<string>"
  },
  "secrets": {},
  "code": "<string>",
  "icon": "<string>",
  "readme": "<string>",
  "title": "<string>",
  "description": "<string>",
  "url": "<string>",
  "public": true,
  "layers": [
    "<string>"
  ]
}'

{
  "integration": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "identifier": {
      "fallbackHandlerScript": "<string>",
      "extractScript": "<string>"
    },
    "sandbox": {
      "identifierExtractScript": "<string>",
      "messageExtractScript": "<string>"
    },
    "url": "<string>",
    "name": "<string>",
    "version": "<string>",
    "interfaces": {},
    "configuration": {
      "title": "<string>",
      "description": "<string>",
      "identifier": {
        "linkTemplateScript": "<string>",
        "required": true
      },
      "schema": {}
    },
    "configurations": {},
    "channels": {},
    "states": {},
    "events": {},
    "actions": {},
    "user": {
      "tags": {},
      "creation": {
        "enabled": true,
        "requiredTags": [
          "<string>"
        ]
      }
    },
    "entities": {},
    "dev": true,
    "title": "<string>",
    "description": "<string>",
    "iconUrl": "<string>",
    "readmeUrl": "<string>",
    "public": true,
    "verificationStatus": "unapproved",
    "secrets": [
      "<string>"
    ]
  }
}

Chat API

Admin API

Files API

Tables API

Runtime API

updateIntegration

Path Parameters

Body

Response