curl --request PUT \
--url https://api.botpress.cloud/v1/admin/integrations/{id}/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-workspace-id: <api-key>' \
--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>"
]
}'
{}
Perform a validation of an integration update request
curl --request PUT \
--url https://api.botpress.cloud/v1/admin/integrations/{id}/validate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-workspace-id: <api-key>' \
--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>"
]
}'
{}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Your workspace ID.
Integration Version ID
Integration
The body is of type object
.
Validation succeeded: the integration can be updated using the same parameters
The response is of type object
.
Was this page helpful?