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.

PagerDuty Plugin

pagerduty: PagerDuty trigger/resolve step

  • routingKey : String
  • dedupKey : String (optional)
  • incidentClass : String (optional)
  • incidentComponent : String (optional)
  • incidentGroup : String (optional)
  • incidentSeverity : String (optional)
  • incidentSource : String (optional)
  • incidentSummary : String (optional)
  • numPreviousBuildsToProbe : int (optional)
  • resolve : boolean (optional)
  • resolveOnBackToNormal : boolean (optional)
  • triggerOnAborted : boolean (optional)
  • triggerOnFailure : boolean (optional)
  • triggerOnNotBuilt : boolean (optional)
  • triggerOnSuccess : boolean (optional)
  • triggerOnUnstable : boolean (optional)

pagerdutyChangeEvent: PagerDuty Change Event step

  • integrationKey : String
  • customDetails : String (optional)
  • summaryText : String (optional)

step([$class: 'ChangeEvents']): PagerDuty Change Events

Create Change Events on PagerDuty services when jobs complete.
  • integrationKey : String
    This is the 32 character Integration Key for an Integration on a Service, or a token that resolves to the key. The token must use the form ${ENV, var="token"}. Ex. ${ENV, var="my_integration_key"}
  • createOnAborted : boolean (optional)
    Create a PagerDuty Change Event if the job ends as ABORTED.
  • createOnFailure : boolean (optional)
    Create a PagerDuty Change Event if the job ends as FAILURE.
  • createOnNotBuilt : boolean (optional)
    Create a PagerDuty Change Event if the job ends as NOT_BUILT.
  • createOnSuccess : boolean (optional)
    Create a PagerDuty Change Event if the job ends as SUCCESS.
  • createOnUnstable : boolean (optional)
    Create a PagerDuty Change Event if the job ends as UNSTABLE.
  • customDetails : String (optional)
    The JSON to be included in the custom details of the change event. Token macro substitution is enabled for this field, but must use the form ${ENV, var="token"}. Ex. {"field":"${ENV, var="my_token"}"}
  • summaryText : String (optional)
    This is an alternate summary text, that can be passed onto Pager duty change events. If omitted it will default to current build's fullDisplayName. Token macro substitution is enabled for this field, but must use the form ${ENV, var="token"}. Ex. Build completed for ${ENV, var="my_build_product"}

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.