Developer Section

This section offers API documentation, code samples, and integration tutorials. Tailored for developers, it provides tools, references, and best practices for building and customizing solutions with Botium and external software, ensuring seamless integration and effective API use.

  • Programmatic Access with API Keys

    API Keys for programmatic access to the Botium GraphQL API can be created with the following information: The permissions an API Key is allowed to use. The validity period. Steps to Create API Key In Botium, go to Botium Tools...

  • How to develop your own Botium Connector

    If you cant find the connector you need in the library of connectors, no need to worry. You can build your own Botium Connector to connect to your chatbot. Continue reading to learn more. Connectors are the bridge between Botium...

  • How to develop your own HTTP/JSON Botium Connector

    For low to medium complexity APIs based on HTTP/JSON, you can leverage the included Generic HTTP(S)/JSON Connector and adapt it to your needs. Extend the Generic HTTP/JSON Connector To develop your own Botium Connector based on the Ge...

  • How to deploy my own Botium Connector

    So you followed one of the tutorials for creating your own custom Botium connector and now you need to deploy your new Connector to Botium. This article will show you how to deploy your custom connector. How to develop ...

  • How to Setup a Connector to a Genesys Environment

    To Setup a Connector to a Genesys Environment, follow the steps here. Refer to the full list of Botium Connectorsfor more information on supported Connectors and their capabilities. There are two possible configurations for a Gen...

  • The Botium Bot (bot-to-user) Message

    Botium Bot Message is a common format for bot-to-user messages. Note: Botium Connectors are converting the chatbot provider-specific bot-to-user message to a Botium Bot Message. These Bot messages can then be asserted via ...

  • The Botium User (user-to-bot) message

    Botium User Message is a common format for user-to-bot messages. Note: Botium Connectors are converting the chatbot provider-specific user-to-bot message to a Botium Bot Message. These Bot messages can then be asserted via ...

  • Deploying a LivePerson Connector

    The following tutorial will guide you through setting up a LivePerson conversational AI and connecting it to your Botium. Note: Botium will connect to the LivePerson Conversational AI via the Connector API messaging chan...

  • Git Repository Integration

    We recommend as Best Practice to store your Botium test cases in a Git repository, and connect your Git repository to Botium. Git Repository Registration In the Botium registration page, it is possible to set the Git Clone Url th...

  • Developing Custom Logic Hooks

    With some Javascript development know-how, you can extend Botium with your own logic hooks. Parent topic: Developer Section Logic Hooks There are currently nine types of logic hook events where you can add your custom logic: onConv...

  • Developing Custom Asserters

    With some Javascript development know-how, you can extend Botium with your own asserter logic. Parent topic: Developer Section Asserter Hooks There are currently three types of asserter hooks where you can add your custom lo...

  • Register a Custom Asserter in Botium

    Here are generic instructions to help you register and configure an asserter in Botium. To register an asserter, do the following: Deploy the Asserter Code (NPM-package, Javascript File) to the Botium inst...

  • Customizing Test Results in Botium

    Botium provides test result download links in formats suitable for further processing. The structure of these downloads can be customized to fit your needs. Continue reading to learn more. For example, the Jira export file from B...

  • Supported Capabilities for HTTP(S)/JSON Based APIs

    This article details configuring SIMPLEREST capabilities in Botium, including URL construction, HTTP methods, headers setup, and the role of Mustache templates in creating custom chatbot connections. It also explains the use ...

  • Generic HTTP(S)/JSON Connector

    Lots of chatbots connect to a simple HTTP/JSON based API in the backend to handle user requests and prepare the responses. This Botium connector mode enables Botium to connect to such an API. Features Sync API supported. (...

  • Using the Botium GraphQL API

    Botium is exposing a GraphQL API. It can be used by developers to programmatically do everything you can do with the Botium web client: Click here for more information on using a GraphQL API. compose test cases and test suites co...

  • Botium Extension Points for Developers

    Task Botium Extension Point Further Information I want to connect Botium with my self-developed chatbot. Customize one of the Generic Botium Connectors listed on the right Develop your own...