Documentation

Installation

Choose the installation method that matches your workflow:

/plugin marketplace add askqa-ai/askqa-plugins
/plugin install askqa
/setup-mcp

{
  "mcpServers": {
    "askqa": {
      "command": "npx",
      "args": ["-y", "@askqa/mcp"],
      "env": {
        "AUTOQA_API_URL": "https://api.askqa.ai",
        "AUTOQA_API_KEY": "aq_..."
      }
    }
  }
}

Environment Variables

Tools

Notifications

Get alerts when a scheduled test fails. AskQA supports email, Telegram, and Slack.

Email

Tell your AI assistant:

“Send email notifications to [email protected] when tests fail”

Or call add_notification_channel with channel_type: "email" and your email_address.

Telegram

To get your chat ID, open @userinfobot in Telegram, press Start, and it will reply with your ID.

Then tell your AI assistant:

“Add Telegram notifications with chat ID 123456789”

Or call add_notification_channel with channel_type: "telegram" and your chat_id.

Slack

Slack requires a lightweight “app” to generate a webhook URL — it takes under a minute and no coding is involved.

• Go to api.slack.com/apps and click Create New App → From scratch
• Name it anything (e.g. “AskQA”), pick your workspace, click Create App
• Go to Incoming Webhooks in the sidebar and toggle it on
• Click Add New Webhook to Workspace, choose a channel, click Allow
• Copy the webhook URL

Then tell your AI assistant:

“Add Slack notifications with this webhook: https://hooks.slack.com/services/T.../B.../xxx”

Or call add_notification_channel with channel_type: "slack" and your webhook_url.

A test message is sent automatically when you add a channel. You can manage channels with list_notification_channels and remove_notification_channel.

Test healing

Sites change. When a redesign moves an element or renames a label, a previously-passing test starts failing — even though the feature still works. AskQA detects this kind of layout regression (a confirmed run of failures after a prior pass, caused by a selector that no longer matches — not an outage) and repairs the selectors without changing what the test checks. Test logic, steps, assertions, and navigation stay identical; only selectors and the wording used to detect a UI state may change.

On demand, in your AI client (all plans)

Ask your assistant to fix a failing test and it calls heal_test, which confirms the regression, re-runs the test to capture the current page, and proposes new selectors. It verifies the fix with validate_test and applies it with update_test once it passes.

"My checkout test started failing after we changed the page — can you fix it?"

Automatic Pro

On Pro, AskQA heals in the background: when a scheduled test fails because of a layout change, it prepares a fix, verifies it in a sandbox dry-run, and sends you a notification with a link to review the before/after diff and Apply or Dismiss in one click. It re-checks the fix at apply time, and nothing changes until you approve it.

Healing is suggest-only and never edits a test on its own. If a failure is acceptable or you’d rather fix it yourself, dismiss the suggestion to stop further attempts — it re-enables automatically once the test passes again.

Secrets

Tests can store encrypted credentials for authenticated flows — logins, API keys, wallet addresses, or any key-value pairs your test needs.

Secrets are encrypted at rest (AES-256-GCM) and never returned in API responses. They're only decrypted when the test runner executes your test.

Adding secrets to a test

Pass a secrets object when creating or updating a test:

“Create a login test for https://example.com with secrets email: [email protected], password: s3cret”

Or via the API / MCP tools with secrets: { "email": "[email protected]", "password": "s3cret" }. Pass secrets: null to clear them.

Using secrets in custom tests

Secrets are available via the secrets parameter in your test function:

async function test({ page, step, log, secrets }) {
  await step("login", async () => {
    await page.fill('input[type="email"]', secrets.email);
    await page.fill('input[type="password"]', secrets.password);
    await page.click('button[type="submit"]');
    await page.waitForURL('/dashboard');
  });
}

The secrets object contains whatever key-value pairs you stored on the test. Common patterns:

Test Mode Header

Every test request to your target domain includes an X-AskQA-Secret header with a unique token for your account. Use it to detect monitoring traffic and enable test-specific behavior on your backend — like using Stripe test keys, skipping real emails, or enabling sandbox mode.

Your token is auto-generated and visible on your account page. You can rotate it at any time.

Backend integration

Check for the header in your server middleware. Set your token as an environment variable:

// Express.js
app.use((req, res, next) => {
  if (req.headers['x-askqa-secret'] === process.env.ASKQA_TEST_SECRET) {
    req.isTestMode = true;
  }
  next();
});

// Then in your checkout route:
const stripeKey = req.isTestMode
  ? process.env.STRIPE_TEST_SECRET_KEY
  : process.env.STRIPE_SECRET_KEY;

# Django
class AskQATestModeMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        secret = os.environ.get('ASKQA_TEST_SECRET', '')
        request.is_test_mode = request.META.get('HTTP_X_ASKQA_SECRET') == secret
        return self.get_response(request)

Per-test control

Each test has an enable_test_mode flag (default: true). When enabled, the X-AskQA-Secret header is sent with requests to your target domain. Set it to false to test the live production path without the header.

This lets you run two versions of the same test side by side — one hitting sandbox (test mode on) and one hitting production (test mode off) — to monitor both paths.

“Create a checkout test with test mode off so it hits live Stripe”

How it works

• The header is scoped to your target domain only — it’s never sent to third-party services
• Enabled by default on all new tests (both template and custom)
• Set enable_test_mode: false on create_test or update_test to disable it
• User-provided headers on individual tests are merged alongside it
• Rotate the token from your account page or via the rotate_org_secret MCP tool

Example Conversations