Skip to main content
  1. Botium Support
  2. Technical Reference
  3. Developer Section

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

  • configure chatbot capabilities

  • work with device sets and Selenium capabilities

  • …

    Tip: For test case execution and reporting, the CI/CD integration API is the better choice for developers.

Launching the GraphQL Playground

Botium includes the GraphQL Playground for exploring and testing the API. It can be accessed by adding the /playground suffix to your Botium web client URL. Example: http://my-botium-box/playground

Authorization

The API is secured, you have to use a Botium API Key to connect - you can find the API Keys in the Settings section of the Botium.
  1. Navigate to Botium Tools & Settings > Settings > Users & Permissions > API Keys

    Note: You need the API Key, not the name.

  2. In the GraphQL Playground, add an APIKEY query parameter to the URL:

  3. Now you can compose your GraphQL queries and mutations.

Botium API Objects

The API exposes the same objects as the web client, including:

  • Test Projects

  • Test Results

  • Test Sets

  • Chatbots (and capabilities)

  • Device Sets

You can query individual objects, retrieve lists, and perform CRUD operations via mutations.

Was this article helpful?

0 out of 0 found this helpful