CI/CD Pipeline Integration

How the Integration Works

Evaficy Smart Test is a manually executed testing tool — a tester opens a run and marks each test case pass or fail step by step. The CI/CD integration does not automate test execution. What it does is give your pipeline a way to kick off that human sign-off at the right moment in your release cycle.

When a pipeline step calls the trigger endpoint, Evaficy creates a new test run in Draft status with all test case snapshots ready. The tester receives a notification, opens the run in Evaficy Smart Test, and executes it normally. The pipeline does not wait — it fires and moves on.

How to Set Up the Integration

The integration requires the Enterprise plan and takes a few minutes to configure. You need one token, two IDs, and a pipeline step.

Endpoint Reference

The trigger endpoint accepts a JSON body and responds immediately. It does not hold the connection open while the run is being executed.

Request body

{
  "projectId":   "<24-char Project ID>",       // required
  "scenarioId":  "<24-char Scenario ID>",      // required
  "environment": "Staging",                    // optional
  "buildVersion": "1.4.2",                     // optional
  "runName": "CI Run — build #42"              // optional — auto-generated if omitted
}

Response (201 Created)

{
  "success": true,
  "runId": "<run ID>",
  "runName": "CI Run — Checkout Flow (1.4.2) — 2026-04-10",
  "testCaseCount": 24,
  "message": "Test run created. Open Evaficy Smart Test to execute it."
}

Example — GitHub Actions

Add this step to any workflow to trigger a test run after a deployment. Store EVAFICY_TOKEN as a repository secret and set EVAFICY_SCENARIO_ID and EVAFICY_PROJECT_ID as repository variables.

name: Create QA Run

on:
  push:
    branches: [main]

jobs:
  create-qa-run:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Evaficy test run
        run: |
          curl -s -X POST https://app.evaficy.com/runs/trigger \
            -H "Authorization: Bearer ${{ secrets.EVAFICY_TOKEN }}" \
            -H "Content-Type: application/json" \
            -d '{
              "scenarioId": "${{ vars.EVAFICY_SCENARIO_ID }}",
              "projectId":  "${{ vars.EVAFICY_PROJECT_ID }}",
              "environment": "Staging",
              "buildVersion": "${{ github.sha }}"
            }'

Example — Jenkins Pipeline

In Jenkins, store the token as a Secret Text credential and reference it with withCredentials. Bind the Scenario ID and Project ID as string parameters or environment variables.

pipeline {
  agent any
  environment {
    EVAFICY_SCENARIO_ID = '<your-scenario-id>'
    EVAFICY_PROJECT_ID  = '<your-project-id>'
  }
  stages {
    stage('Trigger QA Run') {
      steps {
        withCredentials([string(credentialsId: 'evaficy-token', variable: 'EVAFICY_TOKEN')]) {
          sh """
            curl -s -X POST https://app.evaficy.com/runs/trigger \
              -H "Authorization: Bearer ${EVAFICY_TOKEN}" \
              -H "Content-Type: application/json" \
              -d '{"scenarioId":"${EVAFICY_SCENARIO_ID}","projectId":"${EVAFICY_PROJECT_ID}","buildVersion":"${BUILD_NUMBER}","environment":"Staging"}'
          """
        }
      }
    }
  }
}

Test the Endpoint Without a Pipeline

If you do not have a CI/CD pipeline configured yet, you can test the trigger endpoint directly from Evaficy Smart Test. Go to Settings → CI/CD Trigger Test, paste your Personal Access Token, select a project and scenario, and click Send Test Request. If the run is created successfully, it will appear in Test Runs with Draft status.

Common Errors

Most failures are due to a missing or expired token, a wrong plan, or incorrect IDs. The API always returns a message field explaining what went wrong.