Tool to create a new integration in a Botpress workspace via the Admin API. Use when you need to provision a new integration with configuration including name, version, code, actions, events, and channels.
devbooleanIndicates if the integration is a development integration. Dev integrations run locally.
urlstringURL of the integration for development integrations.
codestringJavaScript code of the integration containing the integration logic.
iconstringBase64 encoded SVG of the integration icon. This icon is global to the integration; each version will be updated when this changes.
nameRequiredstringName of the integration (max 200 characters). Typically in the format 'namespace/integration-name'.
userobjectUser object configuration with creation settings and tags.
titlestringTitle of the integration displayed in the UI (1-64 characters).
eventsobjectEvent definitions with schema for custom integration events.
layersarrayList of layer names for the integration.
publicboolean[DEPRECATED] Indicates whether the integration is public. Please use the 'visibility' parameter instead.
readmestringBase64 encoded markdown of the integration readme. The readme is specific to each integration version.
statesobjectState definitions with type and schema.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.