validateIntegrationCreation
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
validateIntegrationCreation
Perform a validation of an integration creation request
POST
/
v1
/
admin
/
integrations
/
validate
curl --request POST \
--url https://api.botpress.cloud/v1/admin/integrations/validate \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"version": "<string>",
"configuration": {
"title": "<string>",
"description": "<string>",
"schema": {},
"identifier": {
"required": true,
"linkTemplateScript": "<string>"
}
},
"configurations": {},
"states": {},
"events": {},
"actions": {},
"entities": {},
"identifier": {
"fallbackHandlerScript": "<string>",
"extractScript": "<string>"
},
"channels": {},
"user": {
"creation": {
"enabled": true,
"requiredTags": [
"<string>"
]
},
"tags": {}
},
"interfaces": {},
"secrets": {},
"code": "<string>",
"url": "<string>",
"dev": true,
"icon": "<string>",
"readme": "<string>",
"title": "<string>",
"description": "<string>",
"public": true,
"layers": [
"<string>"
]
}'
{}
Body
application/json
Integration
The body is of type object
.
Response
200
application/json
Validation succeeded: the integration can be created using the same parameters
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.botpress.cloud/v1/admin/integrations/validate \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"version": "<string>",
"configuration": {
"title": "<string>",
"description": "<string>",
"schema": {},
"identifier": {
"required": true,
"linkTemplateScript": "<string>"
}
},
"configurations": {},
"states": {},
"events": {},
"actions": {},
"entities": {},
"identifier": {
"fallbackHandlerScript": "<string>",
"extractScript": "<string>"
},
"channels": {},
"user": {
"creation": {
"enabled": true,
"requiredTags": [
"<string>"
]
},
"tags": {}
},
"interfaces": {},
"secrets": {},
"code": "<string>",
"url": "<string>",
"dev": true,
"icon": "<string>",
"readme": "<string>",
"title": "<string>",
"description": "<string>",
"public": true,
"layers": [
"<string>"
]
}'
{}