---
title: "Kiwi for Jenkins"
description: "Report check results from Jenkins to a run's Verify step with a checker key."
canonical: "https://kiwiflow.io/integrations/jenkins"
---

# Kiwi for Jenkins

Report check results from Jenkins to a run's Verify step with a checker key.

- Posts named check results over HTTP with a checker key. The key can report only the checks you choose in one project.
- Checks reserved for CI accept results only from a checker key.
- Records each result against the candidate under review. A pass counts toward Verify; a fail means the run needs rework.
- Records a retried report once.
- Kiwi does not start pipelines or read their logs. It records the results your pipeline sends.

## Set up

Store your checker key as a Secret text credential with the ID `kiwi-checker-key` and add `report-kiwi-check.sh` from the setup guide to your repository.

This `Jenkinsfile` runs your tests, then reports the `tests-pass` check as `pass` or `fail`:

```
pipeline {
  agent any
  parameters {
    string(name: 'KIWI_RUN_ID', defaultValue: '', description: 'Kiwi run ID')
  }
  environment {
    KIWI_CHECKER_KEY = credentials('kiwi-checker-key')
  }
  stages {
    stage('Test') {
      steps {
        sh 'npm ci && npm test'
      }
    }
  }
  post {
    always {
      script {
        if (params.KIWI_RUN_ID) {
          env.KIWI_CHECK_STATUS = currentBuild.currentResult == 'SUCCESS' ? 'pass' : 'fail'
          sh './report-kiwi-check.sh tests-pass "$KIWI_CHECK_STATUS" "$BUILD_URL"'
        }
      }
    }
  }
}
```

Run the build with the Kiwi run ID as the `KIWI_RUN_ID` parameter. The first build registers the parameter and does not report.

Run it on an agent that has `curl`, `jq` and `uuidgen`, and set the Jenkins URL so that `BUILD_URL` is filled in.

Replace `tests-pass` with the check ID from your plan.

## More CI/CD integrations

- [Kiwi for AWS CodeBuild](https://kiwiflow.io/integrations/aws-codebuild.md): Report check results from AWS CodeBuild to a run's Verify step with a checker key.
- [Kiwi for Azure Pipelines](https://kiwiflow.io/integrations/azure-pipelines.md): Report check results from Azure Pipelines to a run's Verify step with a checker key.
- [Kiwi for Bitbucket Pipelines](https://kiwiflow.io/integrations/bitbucket-pipelines.md): Report check results from Bitbucket Pipelines to a run's Verify step with a checker key.
- [Kiwi for Bitrise](https://kiwiflow.io/integrations/bitrise.md): Report check results from Bitrise to a run's Verify step with a checker key.
- [Kiwi for Buildkite](https://kiwiflow.io/integrations/buildkite.md): Report check results from Buildkite to a run's Verify step with a checker key.
- [Kiwi for CircleCI](https://kiwiflow.io/integrations/circleci.md): Report check results from CircleCI to a run's Verify step with a checker key.
- [Kiwi for Codemagic](https://kiwiflow.io/integrations/codemagic.md): Report check results from Codemagic to a run's Verify step with a checker key.
- [Kiwi for GitHub Actions](https://kiwiflow.io/integrations/github-actions.md): Report check results from GitHub Actions to a run's Verify step with a checker key.
- [Kiwi for GitLab CI/CD](https://kiwiflow.io/integrations/gitlab-ci.md): Report check results from GitLab CI/CD to a run's Verify step with a checker key.
- [Kiwi for Google Cloud Build](https://kiwiflow.io/integrations/google-cloud-build.md): Report check results from Google Cloud Build to a run's Verify step with a checker key.
- [Kiwi for TeamCity](https://kiwiflow.io/integrations/teamcity.md): Report check results from TeamCity to a run's Verify step with a checker key.
- [Kiwi for Travis CI](https://kiwiflow.io/integrations/travis-ci.md): Report check results from Travis CI to a run's Verify step with a checker key.

- [Get started](https://kiwiflow.io/get-started)
- [Read the setup guide](https://docs.kiwiflow.io/ci-reporting)