Connect Jenkins

Jenkins has no built-in way to push build events, so your pipelines post a small JSON message to Prodgator at the end of each build. Prodgator also calls the Jenkins API with a token you provide to read stages and console logs.

RequirementsCopy Anchor Link

• In Prodgator: the admin role.
• Jenkins reachable over HTTPS from the internet (Prodgator calls its API).
• A Jenkins user and API token for Prodgator. A dedicated read-only user is best.
• curl, openssl and the Credentials Binding plugin on the agents that run your builds.

Step 1: Connect in ProdgatorCopy Anchor Link

1. In Jenkins, create an API token: your user menu, Security > API Token > Add new token.
2. In Prodgator open Admin Console > Integrations and use the Jenkins card.
3. Enter the Jenkins URL (must start with https://), the username and the API token, then click Connect.

Prodgator shows a dialog with:

• Webhook URL: https://api.prodgator.io/api/webhooks/jenkins/{connection id}
• Webhook secret: shown only once. Copy it before closing the dialog.
• Jenkinsfile snippet: ready to paste.

Step 2: Store the secret in JenkinsCopy Anchor Link

Add the webhook secret as a Secret text credential with the ID prodgator-webhook-secret.

Step 3: Add the snippet to your JenkinsfilesCopy Anchor Link

Copy the snippet from the dialog. It looks like this:

post {
  always {
    withCredentials([string(credentialsId: 'prodgator-webhook-secret', variable: 'PRODGATOR_SECRET')]) {
      withEnv(["PRODGATOR_RESULT=${currentBuild.currentResult}", "PRODGATOR_DURATION=${currentBuild.duration}"]) {
        sh '''
          BODY=$(printf '{"projectName":"%s","buildNumber":%s,"buildStatus":"%s","buildUrl":"%s","branch":"%s","commit":"%s","duration":%s}' \
            "$JOB_NAME" "$BUILD_NUMBER" "$PRODGATOR_RESULT" "$BUILD_URL" "${GIT_BRANCH:-}" "${GIT_COMMIT:-}" "$PRODGATOR_DURATION")
          SIG=$(printf '%s' "$BODY" | openssl dgst -sha256 -hmac "$PRODGATOR_SECRET" | sed 's/^.* //')
          curl -fsS -X POST -H 'Content-Type: application/json' -H "X-Jenkins-Token: $SIG" --data "$BODY" '<your webhook URL>'
        '''
      }
    }
  }
}

The X-Jenkins-Token header carries the hex HMAC-SHA256 of the request body, keyed with the webhook secret. Prodgator rejects requests whose signature does not match.

Check the connectionCopy Anchor Link

Run a job that has the snippet. When it finishes, the build appears on the Pipelines page.

What you seeCopy Anchor Link

• One pipeline run per build, named after the job (projectName).
• The status Prodgator shows is mapped from buildStatus. See the Jenkins adapter for the table.
• Stages and console logs are read from the Jenkins API when you open a run. Stages need the Pipeline Stage View plugin, which provides the wfapi endpoints.

Because the snippet runs in post { always { ... } }, Prodgator hears about a build when it finishes, not while it runs.

LimitsCopy Anchor Link

• Deployment approvals are not available for Jenkins. Use the Jenkins input step.
• Freestyle jobs need their own post-build step that sends the same JSON and header.

DisconnectingCopy Anchor Link

Click the delete icon next to the Jenkins server in Admin Console > Integrations. Prodgator deletes the stored token and secret, and later requests to the webhook URL are rejected. Remove the snippet from your Jenkinsfiles.