botium-connector-blip
v1.0.1
Published
Botium Connector for Blip The Botium Connector for Blip is a custom Botium connector that integrates the Botium testing framework with the Blip chatbot platform. It enables automated testing of Blip chatbots by mapping Botium's User and Bot Messages to Bl
Readme
Proprietary License Agreement Black Rock Digital Blip Connector for Botium
Copyright (c) 2025 Black Rock Digital. All rights reserved.
This software, including all source code, documentation, and related materials (collectively, the "Software"), is the proprietary property of Black Rock Digital.
Restricted Use The Software is licensed, not sold. Use, reproduction, modification, distribution, or any other form of exploitation of the Software is strictly prohibited without a valid, written license agreement from Black Rock Digital. Unauthorized use may result in legal action.
Licensing To obtain a license for the Software, contact Black Rock Digital at [email protected] Licensed users are granted a non-exclusive, non-transferable, revocable license to use the Software solely for the purposes specified in the license agreement, subject to the terms and conditions therein.
No Redistribution You may not distribute, sublicense, lease, lend, or otherwise make the Software available to any third party, in whole or in part, without prior written consent from Black Rock Digital.
No Reverse Engineering You may not reverse engineer, decompile, disassemble, or attempt to derive the source code or underlying structure of the Software, except as expressly permitted by applicable law.
Disclaimer of Warranty The Software is provided "AS IS" without any warranties, express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, or non-infringement. Black Rock Digital shall not be liable for any damages arising from the use or inability to use the Software.
Termination Any unauthorized use of the Software will result in immediate termination of any license granted and may lead to further legal action.
Contact For licensing inquiries or to report unauthorized use, contact: Black Rock Digital Email: [email protected]
All rights not expressly granted herein are reserved by Black Rock Digital.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Botium Connector for Blip The Botium Connector for Blip is a custom Botium connector that integrates the Botium testing framework with the Blip chatbot platform. It enables automated testing of Blip chatbots by mapping Botium's User and Bot Messages to Blip's HTTP/JSON API, supporting text, buttons, media, forms, cards, and NLP data. This connector leverages Botium's SimpleRestContainer for HTTP/JSON-based APIs, ensuring robust and flexible integration with Blip's synchronous API (endpoint /commands) and optional asynchronous polling via webhooks. Features
Supported Interactions: User Messages: Text (messageText), buttons, media (e.g., images, audio), and forms. Bot Messages: Text, buttons, media, forms, cards (mapped from Blip collections, lists, and web links), and NLP (intents and entities).
Blip Content Types: Text (text/plain) Buttons (application/vnd.lime.select+json) Media (application/vnd.lime.media-link+json) Forms (application/vnd.lime.document+json) Collections/Carousels (application/vnd.lime.collection+json) Lists (application/vnd.lime.list+json) Web Links (application/vnd.lime.web-link+json)
Synchronous and Asynchronous Support: Synchronous HTTP/JSON API via Blip's /commands endpoint. Optional asynchronous polling for notifications (via /notifications endpoint).
Context Management: Tracks session IDs and scripting memory (e.g., username). NLP Support: Processes intents and entities from Blip's metadata (requires Blip AI extensions). Error Handling: Robust error handling for HTTP status codes and Blip-specific errors. Debugging: Built-in debug logging using the debug library.
Configure botium.json:Edit the botium.json file in your project directory to include the connector and Blip-specific capabilities: { "botium": { "Capabilities": { "PROJECTNAME": "BlipTest", "CONTAINERMODE": "./BlipConnectorGeneric.js", "BLIP_API_URL": "https://http.msging.net", "BLIP_API_KEY": "", "BLIP_CONTRACT_ID": "", "BLIP_DESTINATION": "[email protected]", "BLIP_WEBHOOK_URL": "", "SIMPLEREST_CONTEXT_KEY": "$.resource.sessionId", "SIMPLEREST_CONTEXT_TEMPLATE": "{"sessionId": "{{context.sessionId}}"}" } } }
Obtaining Credentials: BLIP_API_KEY and BLIP_CONTRACT_ID: Available in the Blip Portal under chatbot settings. BLIP_DESTINATION: Default is [email protected], or use your chatbot's specific address. BLIP_API_URL: Default is https://http.msging.net. BLIP_WEBHOOK_URL: Optional, set if using asynchronous notifications (e.g., /notifications endpoint).
