The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page. Notification Plugin

websocketin: Notifier

This plugin sends a websocket message when the build
  • Is about to start (phase=STARTED)
  • In post build (phase=COMPLETED)
All fields support the usage of variables.

Data is sent as websocket text in json format. It is a subset of the Notification plugin and looks as follow:
    "name": "asgard",
    "url": "job/asgard/",
    "build": {
        "full_url": "http://localhost:8080/job/asgard/18/",
        "number": 18,
        "phase": "COMPLETED",
        "status": "SUCCESS",
        "url": "job/asgard/18/",

Note: For phase="STARTED" the build status of the previous build is given (if available)
  • url : String let's you define an own websocket url which is in the form of:


    Note: While wss:// is supported, your jenkins instance might reject the connection. Make sure you have a valid certificate store path given and that the connection to the given host is trusted. Workaround (not recommended): use the unencrypted ws:// Url instead.
  • preventFailOnConnect : boolean
  • startMessage : String
  • additionalHttpHeaders : String
    The additional http headers must follow a format that is recognized by the class java.util.Properties.
    Check Properties file format - Oracle for more information.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?


See existing feedback here.