Perform a validation of an integration creation request
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>"
]
}'
{}
Integration
The body is of type object
.
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>"
]
}'
{}
Perform a validation of an integration creation request
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>"
]
}'
{}
Integration
The body is of type object
.
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>"
]
}'
{}