Issue

A SCM WebHook is not working as expected.

Required Data for WebHook

This article describes how to collect the minimum required information for troubleshooting SCM Webhook issues.

If the required data is bigger than 50 MB you will not be able to use ZenDesk to upload all the information. On this case we would like to encourage you to use our upload service in order to attach all the required information.

Environment

• CloudBees CI (CloudBees Core)
• CloudBees CI (CloudBees Core) on modern cloud platforms - Managed controller
• CloudBees CI (CloudBees Core) on traditional platforms - Client controller
• CloudBees Jenkins Enterprise - Managed controller
• CloudBees Jenkins Platform - Client controller
• CloudBees Jenkins Distribution
  cloudbees-jenkins-x-distribution/)
• Jenkins LTS
• SCM WebHookBitbucket OR GitHub

Required Data check list

SCM side

• Screenshot of the WebHook configuration in Bitbucket OR GitHub

Jenkins side

• Dedicated Loggers
• Support Bundle
• Job Description
• If applicable, the branch indexing logs
• If applicable, plugin configuration (GitHub or Bitbucket)

Dedicated Loggers

Create a dedicated logger depending on the Source Code Management selected for the job.

Git Plugin

For Jenkins for non-multibranch jobs

• hudson.plugins.git.GitStatus - ALL

Bitbucket

non-multibranch jobs

• com.cloudbees.jenkins.plugins.BitbucketJobProbe - ALL
• com.cloudbees.jenkins.plugins.BitBucketTrigger - ALL
• com.cloudbees.jenkins.plugins.BitbucketPayloadProcessor - ALL
• com.cloudbees.jenkins.plugins.BitbucketHookReceiver - ALL

multibranch jobs

• com.cloudbees.jenkins.plugins.bitbucket.hooks - ALL

GitHub

• org.jenkinsci.plugins.github - ALL
• com.cloudbees.jenkins.GitHubWebHook - ALL

Support bundle

Support Bundle generated after adding logging and reproducing the issue. Please, follow the KB below in case you don’t know how to generate a support bundle.

• What is a support bundle and how to create one, please make sure to include Jenkins Global Configuration File (Encrypted secrets are redacted). Otherwise, please attach GitHub/Bitbucket plugin configuration (endpoints, …) as follows:

GitHub plugin configuration

The file $JENKINS_HOME/github-plugin-configuration.xml is needed. Alternatively, you could enable Jenkins Global Configuration File (Encrypted secrets are redacted) and Other Jenkins Configuration Files (Encrypted secrets are redacted) for the support bundle generation.

BitBucket plugin configuration

The file $JENKINS_HOME/com.cloudbees.jenkins.plugins.bitbucket.endpoints.BitbucketEndpointConfiguration.xml is needed. Alternatively, you could enable Jenkins Global Configuration File (Encrypted secrets are redacted) and Other Jenkins Configuration Files (Encrypted secrets are redacted) for the support bundle generation.

Job Description

config.xml of the Jenkins job (for multibranch/organization folder, we need the config.xml of the multibranch/organization project)

Branch Indexing and Events

Just For multibranch jobs, after reproducing the issue, copy into a txt file the output for:

• Multibranch: Scan Multibranch Pipeline Log and Multibranch Pipeline Events
• Organization/Team: Scan Organization Log and Organization Events