How to Set Up a GitHub Webhook in Jenkins

Integrating GitHub with Jenkins using webhooks is a powerful way to automate your CI/CD pipeline. Whenever you push code to your GitHub repository, a webhook can trigger a Jenkins job to build, test, or deploy your application. In this guide, we’ll walk you through the steps to set up a GitHub webhook in Jenkins, complete with placeholders for images to help you visualize the process.

---

Prerequisites

Before you begin, ensure you have the following:

1. A running Jenkins instance.

2. A GitHub repository.

3. Administrative access to both Jenkins and GitHub.

4. The GitHub plugin installed in Jenkins (usually installed by default).

---

Step 1: Configure Jenkins to Accept GitHub Webhooks

1.1 Set Up a Jenkins Job

1. Log in to your Jenkins dashboard.

2. Click on New Item to create a new job.

3. Enter a name for your job (e.g., GitHub-Webhook-Demo), select Freestyle project, and click OK.

4. In the job configuration page:

   • Under Source Code Management, select Git.

   • Enter your GitHub repository URL (e.g., https://github.com/your-username/your-repo.git).

   • Add credentials if your repository is private.

5. Under Build Triggers, check the box for GitHub hook trigger for GITScm polling.

6. Save the job.

Figure 1. Jenkins job configuration

---

1.2 Configure Jenkins URL

1. Go to Manage Jenkins > Configure System.

2. Ensure the Jenkins URL is correctly set (e.g.,

http://your-jenkins-server:8080

1. ). This URL will be used by GitHub to send webhook payloads.

2. Save the configuration.

Figure 2. Jenkins URL setting

---

Step 2: Set Up the GitHub Webhook

2.1 Navigate to Your GitHub Repository

1. Go to your GitHub repository.

2. Click on Settings > Webhooks > Add webhook.

Figure 3. Adding webhook

---

2.2 Configure the Webhook

1. In the Payload URL field, enter your Jenkins server URL followed by /github-webhook/ (e.g., http://your-jenkins-server:8080/github-webhook/).

2. Set the Content type to application/json.

3. Under Which events would you like to trigger this webhook?, select Just the push event (or choose other events as needed).

4. Ensure the Active checkbox is checked.

5. Click Add webhook.

Figure 4. Setting push events

---

Step 3: Test the Integration

3.1 Make a Change in Your Repository

1. Make a small change to your repository (e.g., update a README file).

2. Push the changes to GitHub.

3.2 Verify the Webhook Trigger

1. Go to your Jenkins dashboard.

2. Check if the job you configured has been triggered automatically by the GitHub webhook.

3. Review the build logs to ensure everything is working as expected.

Figure 5. Github push log in Jenkins

---

Step 4: Troubleshooting Tips

If the webhook doesn’t trigger the Jenkins job:

1. Check the GitHub webhook delivery logs for errors.

2. Ensure your Jenkins server is accessible from the internet (if using a public GitHub repository).

3. Verify that the Jenkins URL and webhook URL are correct.

4. Ensure the GitHub plugin is installed and up-to-date in Jenkins.

---

Conclusion

By setting up a GitHub webhook in Jenkins, you can automate your CI/CD pipeline and ensure that every code change triggers a build or deployment process. This integration saves time, reduces manual effort, and improves the efficiency of your development workflow.

Feel free to insert the relevant images in the placeholders provided to make this guide more visually engaging and easier to follow. If you encounter any issues, refer to the troubleshooting tips or consult the official documentation for Jenkins and GitHub.

Happy automating! 🚀