jenkinsci / outbound-webhook-plugin

Jenkins outbound WebHook plugin

Jenkins WebHook plugin

Outbound WebHook for Jenkins build events

Configuration

Configure your Jenkins URL in Jenkins > Configuration section:

Add Outbound Webhook notification to Post-build Actions:

Sample payload

{
  "buildName": "#16",
  "buildUrl": "http://my-jenkins-url.com/job/test%20job/16/",
  "event": "success",
  "projectName": "test job",
  "buildVars": "..."
}

event has four possible values: start, success, failure, unstable.

Compile

./gradlew build

# or within a docker image:
./gradlew-docker build

Test

./gradlew test

# or within a docker image:
./gradlew-docker test

Run server

./gradlew server

# or within a docker image, port 8080 is forwarded to the docker host:
./gradlew-docker server

Visit http://localhost:8080

The first time you visit it, you are required to go through the setup process. Please don't install any third-party plugins. This plugin we currently working on will be installed by default.

Admin user

I use the following credential for testing: admin/admin

Of course you don't have to copy my example.

publish

Create a tag on GitHub: outbound-webhook-plugin-<version>.

Create file ~/.jenkins-ci.org with the following content:

userName=username
password=password

Note: The credentials are from https://accounts.jenkins.io/.

Run:

./gradlew clean publish

# or within a docker image:
./gradlew-docker clean publish

outbound-webhook-plugin's Issues

Must be compatible with JDK11

Official Jenkins docker images are based on JDK11 so it's impossible to use this plugin:

Some plugins could not be loaded due to unsatisfied dependencies. Fix these issues and restart Jenkins to re-enable these plugins.

Dependency errors:

Outbound WebHook for build events (0.3.0)
Java (14) or higher required

Use Environment Variable or Parameter Variable as part of url

What feature do you want to see added?

In the webhook url, allow us to pass some variable (parameters) or environment variable like ${BUILD_NUMBER}.

We tried passing ${BUILD_NUMBER} in the url, and this is the output: it didn't render the build number into the actual build number.

Upstream changes

No response

Add basic auth for webhooks

Hey -- it looks like this is missing any ability to hit webhooks requiring basic auth. Just a suggestion.

can notify 'unstable' state through this Plugin ？

Not showing in Post Build actions

Jenkins and plugins versions report

Jenkins 2.370
After fresh installing plugin not showing in Post Build actions.
Plugin: Outbound WebHook for build events 0.3.0

What Operating System are you using (both controller, and any agents involved in the problem)?

Windows

Reproduction steps

Install plugin

Expected Results

.

Actual Results

.

Anything else?

No response

How to use?

Hi, I'm a beginner with Jenkins. I wish to call an external API whenever my Jenkins build/deploy is complete. Could you point me to the docs, so I can use this tool?

After the installation it is not coming under the post build events

Jenkins and plugins versions report

Environment

Paste the output here

What Operating System are you using (both controller, and any agents involved in the problem)?

LInux - ubuntu 22.04

Reproduction steps

nil

Expected Results

https://github.com/jenkinsci/outbound-webhook-plugin/blob/master/config2.png

Actual Results

That outbook webhook notification tab is not coming

Anything else?

nil

Don't load in last jenkins server

Hi! After the last update module doesn't load in the last jenkins docker image based on Centos latest.
Java version:

openjdk version "1.8.0_252"
OpenJDK Runtime Environment (build 1.8.0_252-b09)
OpenJDK 64-Bit Server VM (build 25.252-b09, mixed mode)

Is there any way to fix it?

UPD#1: Jenkins doesn't support java 14.
Documentation: https://www.jenkins.io/doc/administration/requirements/java/
Error:

SEVERE: Running with Java class version 58 which is not in the list of supported versions: [52, 55]. Run with the --enable-future-java flag to enable such behavior. See https://jenkins.io/redirect/java-support/
--
  | java.lang.UnsupportedClassVersionError: 58.0
  | at Main.verifyJavaVersion(Main.java:174)
  | at Main.main(Main.java:142)
  |  
  | Jenkins requires Java versions [8, 11] but you are running with Java 14 from /usr/lib/jvm/java-14-openjdk-14.0.1.7-2.rolling.el8.x86_64
  | java.lang.UnsupportedClassVersionError: 58.0
  | at Main.verifyJavaVersion(Main.java:174)
  | at Main.main(Main.java:142)

UPD#2: Plugin error:

java.io.IOException: Failed to load: Outbound WebHook for build events (0.3.0)
 - Java (14) or higher required

cc @tylerlong @jamiewastin @jc21

allow webhook subscribers to choose what to subscribe to

currently the only way to configure outbound hooks is to

Add Outbound Webhook notification to Post-build Actions:

However devices should be able to subscribe to various events out of the box, eg with an HTTP put request

Build start event does not get called

My webhook is called only on "success" and "failure", not on build "start"
Am I doing something wrong or is it a bug?
Please resolve asap.

unable to use in pipeline

Please make this plugin useable from a Jenkinsfile pipeline

Where can I get the plug-in logging?

I run this plug-in as the post-build action, while I get nothing from build console log saying webhook is triggered or something like that. Where can I get something?

Cancel event

Hi there!

Are there any plans to add support "cancel"-event?

Does not work with API-scheduled builds

If I create a build with parameters manually in Jenkins UI then everything works fine. If I create one via Jenkins API (POST request to buildWithParameters), the webhook is never triggered and I don't get the information about the build.