Chat API
Admin API
Tables API
Runtime API
curl --request GET \
--url https://api.botpress.cloud/v1/admin/hub/integrations/{id} \
--header 'Authorization: Bearer <token>'{
"integration": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"identifier": {
"fallbackHandlerScript": "<string>",
"extractScript": "<string>"
},
"url": "<string>",
"name": "<string>",
"version": "<string>",
"interfaces": {},
"configuration": {
"identifier": {
"required": true,
"linkTemplateScript": "<string>"
},
"schema": {},
"title": "<string>",
"description": "<string>"
},
"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,
"visibility": "public",
"verificationStatus": "unapproved",
"secrets": [
"<string>"
],
"ownerWorkspace": {
"id": "<string>",
"handle": "<string>",
"name": "<string>"
},
"meta": {
"installs": 123,
"views": 123
},
"sandbox": {
"identifierExtractScript": "<string>",
"messageExtractScript": "<string>"
},
"maxExecutionTime": 123,
"attributes": {}
}
}getPublicIntegrationById
Get public integration by Id
curl --request GET \
--url https://api.botpress.cloud/v1/admin/hub/integrations/{id} \
--header 'Authorization: Bearer <token>'{
"integration": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"identifier": {
"fallbackHandlerScript": "<string>",
"extractScript": "<string>"
},
"url": "<string>",
"name": "<string>",
"version": "<string>",
"interfaces": {},
"configuration": {
"identifier": {
"required": true,
"linkTemplateScript": "<string>"
},
"schema": {},
"title": "<string>",
"description": "<string>"
},
"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,
"visibility": "public",
"verificationStatus": "unapproved",
"secrets": [
"<string>"
],
"ownerWorkspace": {
"id": "<string>",
"handle": "<string>",
"name": "<string>"
},
"meta": {
"installs": 123,
"views": 123
},
"sandbox": {
"identifierExtractScript": "<string>",
"messageExtractScript": "<string>"
},
"maxExecutionTime": 123,
"attributes": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.
Path Parameters
Integration Version ID
Response
Success
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
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
200Show child attributes
Show child attributes
Show child attributes
Show child attributes
ID of the interface
28 - 36Name of the interface
200Version of the interface
200Configuration definition
Show child attributes
Show child attributes
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
256Show child attributes
Show child attributes
Configuration definition
Show child attributes
Show child attributes
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
256Show child attributes
Show child attributes
Channel definition
Show child attributes
Show child attributes
Conversation object configuration
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Message object configuration
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Title of the channel
64Description of the channel
256Show child attributes
Show child attributes
State definition
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Event Definition
Show child attributes
Show child attributes
Title of the event
64Description of the event
256Show child attributes
Show child attributes
Action definition
Show child attributes
Show child attributes
Title of the action
64Description of the action
256User object configuration
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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
[DEPRECATED] Indicates whether the integration is public. Please use the "visibility" parameter instead.
The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them.
public, private, unlisted 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.
Show child attributes
Show child attributes
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
2000Maximum execution time of the integration (in seconds).
Was this page helpful?