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.

Qodex supports seamless CI/CD integration so you can trigger test plans automatically during deployments or pull requests.

​
Option 1: GitHub / CircleCI Integration (Native)

  1. Go to the Test Plans tab in Qodex.
  2. Select an existing test plan or create a new one.
  3. In the CI/CD Integrations tab, link your GitHub or CircleCI account.
  4. Set when the test plan should trigger (e.g., push to main, PR merge).
  5. Once configured, Qodex runs this plan automatically via your GitHub or CircleCI workflows.

​
Option 2: Custom CI/CD Integration via REST API

Use this when integrating with tools like Jenkins, GitLab CI, Bitbucket Pipelines, Azure DevOps, etc.

​
1. Trigger the Test Plan

curl -X POST \
  https://api.app.qodex.ai/api/v1/test_plans/{TEST_PLAN_ID}/run \
  -H 'x-api-key:YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "secrets": {
      "secret1": "value1",
      "secret2": "value2"
    }
  }'
This returns a build_id in the response that you’ll use to check test status.

​
2. Poll for Test Plan Status

curl -H 'x-api-key:YOUR_API_KEY' \
  https://api.app.qodex.ai/api/v1/test_plan_builds/{BUILD_ID}
This returns build status, pass/fail details, and execution logs.