Skip to main content

Bot Editor

The Bot Editor is the heart of the platform, where you bring your bot to life. It's a visual, flow-based canvas that allows you to design your bot's logic by connecting different modules together.

The Canvas​

The main area of the editor is a pannable and zoomable canvas. Here you can:

  • Add Modules: Drag modules from the sidebar to the left of the canvas to add them to your flow.
  • Connect Modules: Drag from the output handles (on the right side of a module) to the input handles (on the left side) of another module to create a connection. These connections, or "edges," define the path of execution and the flow of data.
  • Arrange Modules: Click and drag modules by the header to arrange them in a way that makes sense to you.

The editor includes standard controls for zooming in, zooming out, and fitting the view to your entire flow.

Module Variants​

Some modules have 'variants' which allow you to use them in different ways. For example, the 'Maths' module has variants including addition, subtraction, multiplication and division, while other modules may let you pick a data type using the variant. You can switch between them using the dropdown at the top of the module.

Flow Pages​

To create a new flow page, click the 'Add Flow Page' button under flow pages in the left sidebar. You can also rename and delete your existing flow pages here.

Invalid Flows​

When a module is not fully configured, it will have a red background. This means that all the required inputs have not been connected with an edge or have a constant value entered.

Clicking on a module will show the relevant documentation in the docs sidebar to the right of the editor. This sidebar can be collapsed and resized.

Publishing a Bot​

Once you are happy with your bot's behaviour, you can publish it. Publishing a bot makes it live and able to interact with users.

To publish a bot:

  • Click on the "Publish" button in the top right of the editor to make it live.

If you are on a published version, this button will say Republish, allowing you to push the same version again if needed.

Module Usage​

A progress bar shows how many modules you have used on the current page out of the maximum allowed. This helps you keep track of the complexity of your flows. Create new flow pages when you need more room.

Saving​

  • Saving Indicator: Saving... text will appear whenever your changes are being automatically saved to the server.
  • Autosave: You can toggle on and off autosave in the left sidebar if you don't want your changes to be saved immediately. Saved changes are not automatically published but can't be undone.

Dialogs​

  • Max Versions Reached: If you try to publish a new version when you have reached the maximum number of allowed versions, a dialog will appear. It gives you the option to automatically delete the oldest version to make room for the new one.
  • Start Bot on Publish: If your bot is currently stopped when you click Publish, a dialog will ask for your preference:
    • Publish Only: Creates the new version but leaves the bot in a stopped state.
    • Start and Publish: Starts the bot and publishes the new version simultaneously.

Editable vs. Read-Only Mode​

  • Draft Versions: Are fully editable. You can add, remove, and connect modules freely.
  • Published Versions: Are read-only. This is to prevent accidental changes to a live version of your bot. To make changes, you must first create a new draft version.