Voxli Voxli

Scenario Configurations

Define custom fields on scenarios and tests using configuration templates.

What configurations are

Configuration templates let you add custom fields to your scenarios and tests. Think of them as structured metadata - extra fields that appear alongside the standard name, instruction, and assertions.

Configurations have two levels of fields:

  • Scenario-level fields - appear on the scenario itself. Useful for information that applies to all tests in the scenario.
  • Test-level fields - appear on each test within the scenario. Useful for per-test metadata.

Creating a configuration

  1. Go to Settings > Configuration.
  2. Click to create a new configuration template.
  3. Give the configuration a name.
  4. Add fields. Each field has:
    • Name - the label users see (e.g., “Chatbot ID” or “Target audience”).
    • Type - either Single line text for short values or Long text for multi-line content.
  5. Choose whether each field is a scenario-level or test-level field.
  6. Save the configuration.

Linking a configuration to a scenario

Once you have a configuration template, connect it to a scenario:

  1. On the scenario detail page, open the three-dot menu and click Edit.
  2. In the edit dialog, select your configuration template from the Configuration dropdown.
  3. Save the scenario.

After linking, the custom fields appear in the scenario and test edit forms. Fill in the values as needed - they are stored with the scenario and its tests.

Field types

TypeDescription
Single line textA short text input for brief values like IDs, names, or labels.
Long textA multi-line text area for longer content like descriptions or instructions.

Use cases

Field values are accessible via the API, making configurations primarily useful for passing structured data to external systems and integrations during test execution. For example, you might store a chatbot ID, environment URL, or authentication token that your integration needs when starting a run.

For API details, see Scenario Configurations in the developer docs.

Running Tests

Advanced Run Options