curl --request POST \
--url https://api.botpress.cloud/v1/admin/integrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-workspace-id: <api-key>' \
--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": {
"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>"
]
}
}
Create integration
curl --request POST \
--url https://api.botpress.cloud/v1/admin/integrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-workspace-id: <api-key>' \
--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": {
"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>"
]
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Your workspace ID.
Integration
The body is of type object
.
Success
The response is of type object
.
Was this page helpful?