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.

Discord Notifier

discordSend: Send an embed message to Webhook URL

  • webhookURL
    If you don't have a webhook url take a look at this intro to Discord Webhooks.
    Paste the entire url in the textbox.
    • Type: String
  • customAvatarUrl (optional)
    • Type: String
  • customUsername (optional)
    • Type: String
  • description (optional)
    Message text which supports limited markdown.

    See Markdown Text 101 (Chat Formatting: Bold, Italic, Underline) for more info on markdown support.
    • Type: String
  • enableArtifactsList (optional)
    • Type: boolean
  • footer (optional)
    Text in footer of message
    • Type: String
  • image (optional)
    URL of the image under everything
    • Type: String
  • link (optional)
    When set the title of the message comes clickable and leads to this url.

    To link the executed job use env.BUILD_URL.
    This requires Jenkins URL to be set in Global Settings.
    • Type: String
  • notes (optional)
    • Type: String
  • result (optional)
    Enum to set the build result. Accepts values SUCCESS|UNSTABLE|FAILURE|ABORTED. This field is preferred over success and unstable.
    • Type: String
  • scmWebUrl (optional)
    • Type: String
  • showChangeset (optional)
    • Type: boolean
  • successful (optional)
    Either colors the message as green or red depending on success.
    Use currentBuild.resultIsBetterOrEqualTo('SUCCESS') to color the message green on success or red otherwise.
    • Type: boolean
  • thumbnail (optional)
    URL to image displayed on the right.
    • Type: String
  • title (optional)
    Message title

    To set title to job name, use env.JOB_NAME.
    • Type: String
  • unstable (optional)
    Set to true to set the color to yellow (only when the build was successful, else this is omitted).
    • Type: boolean

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.