Chat API
- Introduction
- Endpoints
Admin API
- Getting started
- Concepts
- Endpoints
- GETgetAccount
- PUTupdateAccount
- GETlistPublicIntegrations
- GETgetPublicIntegrationById
- GETgetPublicIntegration
- POSTcreateBot
- GETlistBots
- PUTupdateBot
- GETgetBot
- DELdeleteBot
- GETgetBotLogs
- GETgetBotAnalytics
- GETgetBotIssue
- DELdeleteBotIssue
- GETlistBotIssues
- GETlistBotIssueEvents
- POSTcreateWorkspace
- GETlistWorkspaces
- GETgetPublicWorkspace
- GETgetWorkspace
- PUTupdateWorkspace
- DELdeleteWorkspace
- GETlistPublicWorkspaces
- GETgetAuditRecords
- GETlistWorkspaceMembers
- POSTcreateWorkspaceMember
- GETgetWorkspaceMember
- DELdeleteWorkspaceMember
- PUTupdateWorkspaceMember
- POSTcreateIntegration
- GETlistIntegrations
- POSTvalidateIntegrationCreation
- PUTupdateIntegration
- GETgetIntegration
- DELdeleteIntegration
- PUTvalidateIntegrationUpdate
- GETgetIntegrationLogs
- GETgetIntegrationByName
- GET
Files API
Tables API
- Getting Started
- Endpoints
Runtime API
- Getting Started
- Concepts
- Endpoints
getIntegrationByName
Get integration
curl --request GET \
--url https://api.botpress.cloud/v1/admin/integrations/{name}/{version}{
"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
Integration Name
Integration version. Either a semver version or tag "latest"
Response
ID of the Integration
28 - 36Creation date of the Integration in ISO 8601 format
Updating date of the Integration in ISO 8601 format
Global identifier configuration of the Integration
VRL Script of the Integration to handle incoming requests for a request that doesn't have an identifier
2000VRL Script of the Integration to extract the identifier from an incoming webhook often use for OAuth
2000URL of the Integration
2000Name of the Integration
200Version of the Integration
200ID of the interface
28 - 36Name of the interface
200Version of the interface
200Configuration definition
Identifier configuration of the Integration
Schema of the configuration in the JSON schema format. The configuration data is validated against this JSON schema.
Title of the configuration
64Description of the configuration
256Configuration definition
Identifier configuration of the Integration
Schema of the configuration in the JSON schema format. The configuration data is validated against this JSON schema.
Title of the configuration
64Description of the configuration
256Channel definition
Message definition
Conversation object configuration
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.
Message object configuration
Title of the channel
64Description of the channel
256State definition
Type of the State (conversation, user or integration)
conversation, user, integration Action definition
Title of the action
64Description of the action
256User object configuration
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.
Indicates if the integration is a development integration; Dev integrations run locally
Title of the integration. This is the name that will be displayed in the UI
1 - 64Description of the integration. This is the description that will be displayed in the UI
256URL of the icon of the integration. This is the icon that will be displayed in the UI
URL of the readme of the integration. This is the readme that will be displayed in the UI
Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
Status of the integration version verification
unapproved, pending, approved, rejected 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.
VRL Script of the Integration to extract the identifier from an incoming webhook used specifically for the sandbox
2000VRL Script of the Integration to extract the message from an incoming webhook used specifically for the sandbox
2000Was this page helpful?
curl --request GET \
--url https://api.botpress.cloud/v1/admin/integrations/{name}/{version}{
"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>"
]
}
}