BotCity icon

BotCity

BotCity orchestrator API

Overview

The node integrates with the BotCity orchestrator API, specifically managing datapools. The "Add Item" operation under the "Datapool" resource allows users to add new items (entries) into a specified datapool. This is useful for dynamically updating datasets that bots or automation workflows rely on, such as adding new user data, configuration parameters, or any structured information stored in datapools.

Practical examples include:

  • Adding new customer records to a marketing datapool.
  • Inserting updated configuration values for automated processes.
  • Populating test data dynamically during workflow execution.

Properties

Name Meaning
Datapool Name or ID Selects the target datapool by name or ID where the item will be added.
Values A collection of key-value pairs representing the fields and their corresponding values to add.

Details about Values:

  • Each entry requires selecting a label (field name) from the datapool's schema.
  • Corresponding value is provided as a string.
  • Multiple values can be added to form one complete item.

Output

The node outputs JSON data representing the result of the add item operation. Typically, this includes confirmation of the item being added or details of the newly created item in the datapool.

If the node supports binary data output, it would relate to any file or media content associated with the datapool item, but based on the provided code and properties, the output is primarily JSON.

Dependencies

  • Requires an API key credential for authenticating with the BotCity orchestrator API.
  • Needs the base URL of the BotCity API configured in credentials.
  • Uses internal methods to load datapool options and labels dynamically, ensuring users select valid datapools and fields.

Troubleshooting

  • Common issues:

    • Selecting a datapool or label that does not exist or is misspelled may cause errors.
    • Providing invalid or empty values for required fields could lead to failed requests.
    • Network or authentication failures if API credentials are incorrect or missing.
  • Error messages:

    • Authentication errors typically indicate invalid or missing API keys.
    • Validation errors may occur if required fields are missing or values do not conform to expected formats.
    • API connection errors suggest issues with the base URL or network connectivity.

To resolve these:

  • Verify API credentials and endpoint URLs.
  • Ensure all required fields are filled with valid data.
  • Check network access and firewall settings.

Links and References

Discussion