Skip to content

Testing Tools

The tool test panel lets you execute a tool with sample parameter values and inspect the full HTTP response before using it in a live bot. This is the fastest way to verify that your URL, headers, body, authentication, and response mapping are configured correctly.

Opening the Test Panel

There are two ways to open the test panel:

  1. From the Tools list -- Click a custom tool to open its editor, then click Test in the toolbar.
  2. From the Flow Builder -- Select a Tool Call node or an LLM Response node with tools enabled, then click the Test Tool button in the config panel.

Providing Test Parameter Values

The test panel displays an input field for each parameter defined on the tool. Fill in sample values to simulate a real invocation:

ParameterTypeSample Value
order_idstringORD-12345
amountnumber50.00
payment_methodenumcard_on_file (dropdown)
confirmedbooleantrue (toggle)
  • Required parameters are marked with an asterisk. The test will not execute if required parameters are empty.
  • Enum parameters display a dropdown with the allowed values.
  • Boolean parameters display a toggle switch.
imageTool test panel showing parameter input fields for order_id (string), amount (number), and payment_method (enum dropdown), with Run Test button and response body area below
The tool test panel with parameter inputs and response

Mock Environment Variables

The test panel also shows fields for environment variables referenced in the tool's configuration. Default mock values are pre-filled:

BACKEND_API:  https://api.example.com/v1
API_KEY:      test_api_key_123

Update these to match your real (or staging) environment if you want the test to hit a real API. If your tool references {{auth_token.access_token}}, the test panel provides a mock token value automatically.

TIP

For safe testing, point BACKEND_API at a staging or sandbox environment. This lets you verify the full request/response cycle without affecting production data.

Executing a Test Call

Click Run Test to execute the tool. The platform performs these steps:

  1. Substitutes all {{param.*}}, {{env.*}}, and {{auth_token.*}} placeholders with the values you entered.
  2. Constructs the HTTP request (method, URL, headers, body).
  3. Sends the request to the target API.
  4. Captures the response and displays it in the results panel.

A spinner appears while the request is in progress. Most API calls complete in under two seconds.

Viewing the Response

The test results panel shows four tabs:

Response Body

The parsed JSON response from the API. Formatted and syntax-highlighted for readability.

json
{
  "order_id": "ORD-12345",
  "status": "in_transit",
  "estimated_delivery": "2026-01-25",
  "tracking_url": "https://tracking.example.com/ORD-12345"
}

Status & Headers

The HTTP status code and response headers:

FieldValue
Status200 OK
Content-Typeapplication/json
X-Request-Idreq_abc123
Duration142ms

Resolved Request

imageResolved Request tab showing the fully constructed HTTP request with all placeholders replaced by actual values, including URL, headers, and body
The resolved request with substituted placeholders

Shows the fully resolved request that was sent, with all placeholders replaced. This is invaluable for debugging -- you can see exactly what URL was called, what headers were sent, and what body was posted.

GET https://api.example.com/v1/orders/ORD-12345/status
X-API-Key: sk_test_abc123

Response Mapping Preview

If the tool has response mapping configured, this tab shows which session variables would be set and their values:

VariableJSONPathResolved Value
status$.status"in_transit"
delivery_date$.estimated_delivery"2026-01-25"
tracking_url$.tracking_url"https://tracking.example.com/ORD-12345"

Debugging Failed Calls

When a test fails, the panel highlights the error. Common issues:

ErrorLikely CauseSolution
Connection refusedInvalid URL or server downVerify BACKEND_API and that the API is reachable
401 UnauthorizedInvalid credentialsCheck API_KEY or token in mock environment variables
404 Not FoundWrong URL pathCheck URL pattern and parameter values
422 UnprocessableBody schema mismatchCompare body template with API documentation
TimeoutAPI too slowVerify API health; consider timeout settings

WARNING

If the resolved request shows unsubstituted placeholders like [env.API_KEY], the variable was not found. Check that it is defined in Settings > Tool Environment and that names match exactly.

Viewing Execution Logs

After a tool has been used in live conversations, you can review execution logs:

  1. Navigate to Tools and click the tool you want to inspect.
  2. Open the Execution Log tab.
  3. Each entry shows: timestamp, conversation ID, parameter values, HTTP status, response time, and success/failure.

Filter logs by date range, status code, or conversation ID to find specific executions.

Testing Checklist

Before deploying a tool to a live bot, verify:

  • [ ] The resolved URL matches the expected API endpoint.
  • [ ] Authentication headers are present and correctly substituted.
  • [ ] The request body contains valid JSON with all required fields.
  • [ ] The API returns a 2xx status code.
  • [ ] Response mapping extracts the expected fields into the correct variables.

OmniBots AI Bot Platform