> User Documentation Home

User Handbook
Tutorials
Resources

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.

Notify.Events

View this plugin on the Plugins site

notifyEvents: Send notification

  • attachBuildLog (optional)
    • Type: boolean
  • attachment (optional)
    • Type: String
  • level (optional)
    • Type: String
  • message (optional)
    • Type: String
  • priority (optional)
    • Type: String
  • title (optional)
    • Type: String
  • token (optional)
    • Type: String

step([$class: 'NotifyEventsBuilder']): Notify.Events

  • token
    • Type: String
  • title
    • Type: String
  • message
    • Type: String
  • priority
    • Type: String
  • level
    • Type: String
  • attachBuildLog
    • Type: boolean
  • attachment
    • Type: String

step([$class: 'NotifyEventsPublisher']): Notify.Events

  • token
    • Type: String
  • title
    • Type: String
  • message
    • Type: String
  • attachBuildLog
    • Type: boolean
  • attachment
    • Type: String
  • onSuccess
    • Type: boolean
  • onSuccessCustom
    • Type: boolean
  • onSuccessCustomTitle
    • Type: String
  • onSuccessCustomMessage
    • Type: String
  • onSuccessCustomPriority
    • Type: String
  • onSuccessCustomLevel
    • Type: String
  • onSuccessCustomAttachBuildLog
    • Type: boolean
  • onSuccessCustomAttachment
    • Type: String
  • onUnstable
    • Type: boolean
  • onUnstableCustom
    • Type: boolean
  • onUnstableCustomTitle
    • Type: String
  • onUnstableCustomMessage
    • Type: String
  • onUnstableCustomPriority
    • Type: String
  • onUnstableCustomLevel
    • Type: String
  • onUnstableCustomAttachBuildLog
    • Type: boolean
  • onUnstableCustomAttachment
    • Type: String
  • onFailure
    • Type: boolean
  • onFailureCustom
    • Type: boolean
  • onFailureCustomTitle
    • Type: String
  • onFailureCustomMessage
    • Type: String
  • onFailureCustomPriority
    • Type: String
  • onFailureCustomLevel
    • Type: String
  • onFailureCustomAttachBuildLog
    • Type: boolean
  • onFailureCustomAttachment
    • Type: String
  • onAborted
    • Type: boolean
  • onAbortedCustom
    • Type: boolean
  • onAbortedCustomTitle
    • Type: String
  • onAbortedCustomMessage
    • Type: String
  • onAbortedCustomPriority
    • Type: String
  • onAbortedCustomLevel
    • Type: String
  • onAbortedCustomAttachBuildLog
    • Type: boolean
  • onAbortedCustomAttachment
    • Type: String

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.