Skip to main content

Documentation Index

Fetch the complete documentation index at: https://qodex.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

This section explains how Qodex helps you organize, schedule, track, and stay notified about your tests. You’ll learn how to:
  • Group test scenarios into Test Suites
  • Automate them with Test Plans
  • Track health and coverage in Dashboards
  • Dive deep with Build Reports
  • Stay updated through Slack & Email Alerts
Together, these features give you full visibility and control over your testing lifecycle.

​
Test Suites

A Test Suite is a collection of related test scenarios grouped together so you can run them as a unit. Examples of Test Suites:
  • Regression Suite
  • Authentication & Security Tests
  • Core Flows (Signup, Login, Payments)
  • Microservice-specific suites
How to create a Test Suite:
  1. Go to Test Scenarios.
  2. Select multiple active scenarios.
  3. Click Create New Test Suite or + Add to Test Suite.
  4. Run the suite anytime, or add it into a Test Plan.
Benefits:
  • Organize tests by feature, service, or risk profile.
  • Manage large test libraries more easily.
  • Run multiple scenarios with a single click.

​
Test Plans

A Test Plan automates the execution of one or more suites on a defined schedule. How to create a Test Plan:
  1. Go to Test Plans.
  2. Either:
    • Create a new Plan → select the Suites you want, or
    • From a Test Suite → click Create Test Plan / + Add to Test Plan.
  3. Open Details → Edit to define when to run.
  4. Add notifications (Slack, Email, Webhook).
Scheduling options:
  • Daily (ideal for staging environments)
  • Weekly (full regression checks)
  • On Deploy (triggered by CI/CD)
  • Custom (via cron pattern)
Benefits:
  • Continuous testing without manual triggers.
  • Validate staging and production APIs regularly.
  • Catch regressions early and proactively.
  • Notify stakeholders automatically.

​
Dashboards

The Dashboard provides a live view of your testing health. What you’ll see:
  • API test coverage
  • Pass/fail trends over time
  • Total tests executed
  • Environments tested
  • Recent failures
Benefits:
  • Quick visibility for engineering and QA leaders.
  • Spot trends in regressions early.
  • Prove test coverage during audits or reviews.

​
Build Reports

Every test run in Qodex - manual, scheduled, or via CI/CD generates a Build Report. This gives full visibility into results across APIs, environments, and timeframes. What’s included:
  • Summary: total tests, passed, failed, skipped, time per test, environment.
  • Scenario details: pass/fail for each test, grouped by Suite, with case links.
  • Test case detail: request (method, URL, headers, body), response (status, time), validation rules, DB checks, errors/diffs.
  • “Fix Me” options: auto-update test logic when failures are caused by API changes rather than bugs.
  • History: compare reports across runs to track regressions and reliability.
Where to find them:
  • Build Reports tab in the main navigation.
  • Linked directly from Slack/Email alerts.
  • Automatically generated on every run.
Why it matters:
  • Visibility into not just pass/fail, but why.
  • Faster debugging (request + response + validations in one place).
  • Track regression trends and coverage over time.
  • Reduce maintenance overhead with “Fix Me.”

​
Slack and Email Alerts

Qodex can notify your team instantly when tests complete so you never miss regressions. What alerts can include:
  • New test failures
  • API regressions
  • Flaky test detection
  • Auto-healed tests
  • Coverage drops
  • Full run summaries or incremental changes
Where alerts can go:
  • Slack (any channel)
  • Email (to one or more recipients)
  • Webhooks (PagerDuty, Microsoft Teams, etc.)
How to set up:
  1. Go to Test Plans.
  2. Create or edit a Plan.
  3. In Plan Details → Notifications, add Slack channels, email recipients, or a webhook URL.
  4. Save alerts now trigger automatically on every run.
Benefits:
  • Keep the team in the loop without checking reports manually.
  • Catch regressions before they reach production.
  • Help developers act faster with direct links to Build Reports.
  • Give QA and platform teams visibility across environments.
  • Provide traceability during reviews or incidents.