CI/CD Integration

Authentication

Generate a secret key and set it as WEBHOOK_API_KEY in your Vercel environment variables. Pass the same value in every request.

# Option A — x-api-key header (recommended)
x-api-key: your_secret_key

# Option B — Authorization header
Authorization: Bearer your_secret_key

Endpoint

Request body

Response

Returns 200 when score >= failThreshold, 422 otherwise. Your CI runner treats 422 as a build failure.

{
  "passed": true,
  "score": 87,
  "failThreshold": 75,
  "scanId": "3fa85f64-...",
  "url": "https://your-app.vercel.app",
  "reportUrl": "https://qa.viyalabs.com/report/3fa85f64-...",
  "summary": {
    "totalPages": 8,
    "totalIssues": 3,
    "critical": 0,
    "medium": 2,
    "low": 1
  },
  "criticalIssues": []
}

Examples

curl

curl -f -X POST https://qa.viyalabs.com/api/webhook/scan \
  -H "x-api-key: $AGENTQA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://your-app.vercel.app","failThreshold":75}'

GitHub Actions

# .github/workflows/qa.yml
name: QA Gate

on:
  deployment_status:

jobs:
  qa:
    if: github.event.deployment_status.state == 'success'
    runs-on: ubuntu-latest
    steps:
      - name: Run QA scan
        run: |
          curl -f -X POST https://qa.viyalabs.com/api/webhook/scan \
            -H "x-api-key: ${{ secrets.AGENTQA_API_KEY }}" \
            -H "Content-Type: application/json" \
            -d '{"url":"${{ github.event.deployment_status.target_url }}","failThreshold":75}'

Vercel + GitHub

# Use Vercel's deployment URL from the CLI output
PREVIEW_URL=$(vercel deploy --token $VERCEL_TOKEN)

curl -f -X POST https://qa.viyalabs.com/api/webhook/scan \
  -H "x-api-key: $AGENTQA_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{"url":"$PREVIEW_URL","failThreshold":80}"

Quick setup

1. 1Generate a secret key — e.g. run: openssl rand -hex 32
2. 2Add WEBHOOK_API_KEY=<your-key> to your Vercel environment variables
3. 3Add AGENTQA_API_KEY as a secret in your GitHub repository (Settings → Secrets)
4. 4Paste the GitHub Actions YAML above into .github/workflows/qa.yml
5. 5Push — scans will run automatically on every successful deployment