pipelineTriggers

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.

pipelineTriggers

pipelineTriggers

triggers

Array / List of Nested Choice of Objects

$class: 'AmqpBuildTrigger'
Add one or more AMQP message source(s) that will provide messages used to trigger a build.
- amqpBrokerParamsList (optional)
  - username : String
  - url : String (optional)
    
    URL for the AMQP source (typically a queue or topic) which will host the queue or topic from which trigger messages will be received.
    
    Format: amqp[s]://<broker-ip-address>[:<port>]
    
    Required
  - password (optional)
    
    If the server requires authentication, then this field must contain the user's password.
    
    If no authentication is required, then leave blank.
    - Type: class hudson.util.Secret
  - sourceAddr : String (optional)
    
    The address of an AMQP message source from which trigger messages will be received. This is frequently a queue or topic on an AMQP broker. The source address must exist, or the server must be capable of creating it on-demand if it does not exist (which may require some server configuration).
    
    Required
  - user : String (optional)
    
    If the broker requires authentication, then this field must contain the user's ID.
    
    If no authentication is required, then leave blank.
$class: 'ArtifactoryMultibranchTrigger'
- details
  - artifactoryName : String
  - artifactoryUrl : String
  - deployReleaseRepository
    - keyFromText : String
    - keyFromSelect : String
    - dynamicMode : boolean
  - deploySnapshotRepository
    - keyFromText : String
    - keyFromSelect : String
    - dynamicMode : boolean
  - resolveReleaseRepository
    - keyFromText : String
    - keyFromSelect : String
    - dynamicMode : boolean
  - resolveSnapshotRepository
    - keyFromText : String
    - keyFromSelect : String
    - dynamicMode : boolean
  - userPluginKey : String
  - userPluginParams : String
- paths : String
- spec : String
- branches : String
$class: 'ArtifactoryTrigger'
- paths : String
- spec : String
- details (optional)
  - artifactoryName : String
  - artifactoryUrl : String
  - deployReleaseRepository
    - keyFromText : String
    - keyFromSelect : String
    - dynamicMode : boolean
  - deploySnapshotRepository
    - keyFromText : String
    - keyFromSelect : String
    - dynamicMode : boolean
  - resolveReleaseRepository
    - keyFromText : String
    - keyFromSelect : String
    - dynamicMode : boolean
  - resolveSnapshotRepository
    - keyFromText : String
    - keyFromSelect : String
    - dynamicMode : boolean
  - userPluginKey : String
  - userPluginParams : String
$class: 'AssemblaBuildTrigger'
- spaceName : String
- repoName : String
- buildOnMergeRequestEnabled : boolean
- mergeRequestCommentsEnabled : boolean
- ticketCommentsEnabled : boolean
- notifyOnStartEnabled : boolean
- buildOnMergeRequestMergedEnabled : boolean
- buildOnMergeRequestIgnoredEnabled : boolean
- triggerOnPushEnabled : boolean
- branchesToBuild : String
- buildDescriptionTemplate : String
- buildStartedTemplate : String
- buildResultTemplate : String
$class: 'BitBucketMultibranchTrigger'
- overrideUrl : String (optional)
bitBucketTrigger
- triggers
  - bitbucketServerPullRequest
    actionFilter
    Nested Choice of Objects
    bitbucketServerPullRequestApproved
    
    triggerOnlyIfAllReviewersApproved : boolean
    
    allowedBranches : String (optional)
    
    bitbucketServerPullRequestCommentCreated
    
    allowedBranches : String (optional)
    
    commentFilter : String (optional)
    
    bitbucketServerPullRequestCreated
    
    allowedBranches : String (optional)
    
    isToApprove : boolean (optional)
    
    isToDecline : boolean (optional)
    
    bitbucketServerPullRequestDeclined
    
    allowedBranches : String (optional)
    
    bitbucketServerPullRequestMerged
    
    allowedBranches : String (optional)
    
    isToApprove : boolean (optional)
    
    bitbucketServerPullRequestSourceUpdated
    
    allowedBranches : String (optional)
    
    isToApprove : boolean (optional)
    
    isToDecline : boolean (optional)
    
    bitbucketServerPullRequestUpdated
    
    allowedBranches : String (optional)
    
    isToApprove : boolean (optional)
    
    isToDecline : boolean (optional)
  - bitbucketCloudPullRequest
    actionFilter
    Nested Choice of Objects
    bitbucketCloudPullRequestApproved
    
    triggerOnlyIfAllReviewersApproved : boolean
    
    allowedBranches : String (optional)
    
    bitbucketCloudPullRequestCommentCreated
    
    allowedBranches : String (optional)
    
    commentFilter : String (optional)
    
    bitbucketCloudPullRequestCommentDeletedActionFilter
    
    allowedBranches : String (optional)
    
    bitbucketCloudPullRequestCommentUpdated
    
    allowedBranches : String (optional)
    
    commentFilter : String (optional)
    
    bitbucketCloudPullRequestCreatedActionFilter
    
    allowedBranches : String (optional)
    
    isToApprove : boolean (optional)
    
    isToDecline : boolean (optional)
    
    bitbucketCloudPullRequestDeclined
    
    allowedBranches : String (optional)
    
    bitbucketCloudPullRequestMerged
    
    allowedBranches : String (optional)
    
    isToApprove : boolean (optional)
    
    bitbucketCloudPullRequestUpdated
    
    allowedBranches : String (optional)
    
    isToApprove : boolean (optional)
    
    isToDecline : boolean (optional)
  - $class: 'BitBucketPPRRepositoryTriggerFilter'
    actionFilter
    Nested Choice of Objects
    $class: 'BitBucketPPRRepositoryPushActionFilter'
    
    triggerAlsoIfTagPush : boolean
    
    triggerAlsoIfNothingChanged : boolean
    
    allowedBranches : String
    
    isToApprove : boolean (optional)
    
    triggerOnlyIfTagPush : boolean (optional)
    
    $class: 'BitBucketPPRServerRepositoryPushActionFilter'
    
    triggerAlsoIfTagPush : boolean
    
    triggerAlsoIfNothingChanged : boolean
    
    allowedBranches : String
    
    isToApprove : boolean (optional)
    
    triggerOnlyIfTagPush : boolean (optional)
- credentialsId : String (optional)
- propagationUrl : String (optional)
bitbucketPush
- buildOnCreatedBranch : boolean (optional)
- overrideUrl : String (optional)
bitbucketpr
Builds pull requests from Bitbucket.org and will report the test results.

This plugin requires Git SCM plugin configured as follows:
- Add Repository URL, git@bitbucket.org:${repositoryOwner}/${repositoryName}.git
- In Branch Specifier, type */${sourceBranch}
- projectPath : String
- bitbucketServer : String
  URL of the Bitbucket Server. Leave it blank if Bitbucket Cloud is used
- cron : String
- credentialsId : String
- username : String
- password : String
- repositoryOwner : String
- repositoryName : String
- branchesFilter : String
  Filter option in custom format. Default value is empty or any.
  Available formats:
  
  any pull requests applied for this project: any, * or empty string
  
  filtered by destination branch: my-branch or more complex reg-ex filter r:^master (must be started with r: and case insensitive match).
  
  filtered by source and destination branches: s:source-branch d:dest-branch
  
  filtered by source and destination branches with regex: s:r:^feature d:r:master$
  
  filtered by many destination/source branches: s:one s:two s:three d:master d:r:master$
  
  filtered by many sources branches: s:one s:two s:r:^three d:
  
  When you using format with source branch filter s or destination filter d, you must specify great than one source and destination filter, eg s:1 s:2 s:... d:.
  Any sources and any destinations for pull request:
  
  filter string: *
  
  filter string: s: d:
- branchesFilterBySCMIncludes : boolean
  Uses the Git SCM option "Branches to build" option as the value for "BranchesFilter". If the "BranchesFilter" field itself has any content, it will be ignored.
  If the "Branches to build" option has values "*/master */feature-master */build-with-jenkins", then "BranchesFilter" field will have value "d:master d:feature-master d:build-with-jenkins".
- ciKey : String
  The identifier needs to be unique among your Jenkins jobs related to this repo. This identifier is used to decide whether a commit is already built by this job and to set status for a newly built commit. If the value is changed rebuilds may occur and multiple statuses might show on an existing pull request. The value is not shown for end users of Bitbucket.
- ciName : String
  This value is the name of the current job when showing build statuses for a pull request.
- ciSkipPhrases : String
  A comma-separated list of strings to search the pull request title for.
  e.g. If set to "trivial,[skiptest]", any PRs containing either "trivial" or "[skiptest]" (case-insensitive) will not be built.
- checkDestinationCommit : boolean
- approveIfSuccess : boolean
- cancelOutdatedJobs : boolean
  If you make a new commit into your PR and there is already running job on that PR, this option will cancel such a outdated job and allows to run only one job at given PR with the newest commit.
- buildChronologically : boolean
  Build Pull Requests in reverse order - older request will be build first
- commentTrigger : String
BitbucketWebhookMultibranchTrigger
- pullRequestTrigger : boolean
  
  This triggers a branch scan after a pull request is opened, it also updates builds by disabling builds after a pull request is declined, deleted, or merged.
- refTrigger : boolean
  
  This triggers a branch scan after new code is pushed.
BitbucketWebhookTriggerImpl
- pullRequestTrigger : boolean
  
  This triggers a build after a pull request is opened, or the source branch of a pull request is updated.
- refTrigger : boolean
  
  This triggers a build in Bitbucket after every push to the configured repository.
$class: 'BuildResultTrigger'
- cronTabSpec : String
- combinedJobs : boolean
- jobsInfo
  - jobNames : String
  - checkedResults
    - result : String
      
      Give a build result to monitor for the selected job.
ciBuildTrigger
- noSquash : boolean (optional)
  
  Schedule a new job for every triggering message.
  
  Normally if a job is queued and another triggering message is received, a new job is not submitted and the job is "squashed" into the job already queued. Checking this option forces a new job to be submitted for every triggering message that is received.
- providerData (optional)
  - activeMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    messageProperties : String (optional)
    
    KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
    
    messageType (optional)
    
    Type of CI message to be sent.
    
    Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - activeMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    selector : String (optional)
    
    JMS selector to choose messages that will fire the trigger.
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - fedmsgPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - fedmsgSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - rabbitMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    fedoraMessaging : boolean (optional)
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    schema : String (optional)
    
    Path to message schema.
    
    severity : int (optional)
    
    Severity of the message.
  - rabbitMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
- providerList (optional)
  - activeMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    messageProperties : String (optional)
    
    KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
    
    messageType (optional)
    
    Type of CI message to be sent.
    
    Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - activeMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    selector : String (optional)
    
    JMS selector to choose messages that will fire the trigger.
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - fedmsgPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    messageContent : String (optional)
    
    Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
  - fedmsgSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message matching the specified JMS selector.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
  - rabbitMQPublisher
    failOnError : boolean (optional)
    
    Whether you want to fail the build if there is an error sending a message. By default, it is false.
    
    fedoraMessaging : boolean (optional)
    
    messageContent : String (optional)
    
    Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    schema : String (optional)
    
    Path to message schema.
    
    severity : int (optional)
    
    Severity of the message.
  - rabbitMQSubscriber
    checks (optional)
    Array / List of Nested Object
    field : String
    
    expectedValue : String
    
    name : String (optional)
    
    overrides (optional)
    Nested Object
    topic : String (optional)
    
    queue : String (optional)
    
    timeout : int (optional)
    
    Value (in minutes) to wait for a message.
    
    variable : String (optional)
    
    Environment variable to hold received message content.
- providers (optional)
  - providerData
    - activeMQPublisher
      
      failOnError : boolean (optional)
      
      Whether you want to fail the build if there is an error sending a message. By default, it is false.
      
      messageContent : String (optional)
      
      Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
      
      messageProperties : String (optional)
      
      KEY=value pairs, one per line (Java properties file format) to be used as message properties. Backslashes are used for escaping, so use "\\" for a single backslash. Current build parameters and/or environment variables can be used in form: ${PARAM}.
      
      messageType (optional)
      
      Type of CI message to be sent.
      
      Values: CodeQualityChecksDone, ComponentBuildDone, Custom, EarlyPerformanceTestingDone, EarlySecurityTestingDone, ImageUploaded, FunctionalTestCoverageDone, FunctionalTestingDone, NonfunctionalTestingDone, OotbTestingDone, PeerReviewDone, ProductAcceptedForReleaseTesting, ProductBuildDone, ProductBuildInStaging, ProductTestCoverageDone, PullRequest, SecurityChecksDone, TestingStarted, TestingCompleted, Tier0TestingDone, Tier1TestingDone, Tier2IntegrationTestingDone, Tier2ValidationTestingDone, Tier3TestingDone, UnitTestCoverageDone, UpdateDefectStatus
      
      name : String (optional)
      
      overrides (optional)
      Nested Object
      topic : String (optional)
      
      queue : String (optional)
    - activeMQSubscriber
      
      checks (optional)
      Array / List of Nested Object
      field : String
      
      expectedValue : String
      
      name : String (optional)
      
      overrides (optional)
      Nested Object
      topic : String (optional)
      
      queue : String (optional)
      
      selector : String (optional)
      
      JMS selector to choose messages that will fire the trigger.
      
      timeout : int (optional)
      
      Value (in minutes) to wait for a message matching the specified JMS selector.
      
      variable : String (optional)
      
      Environment variable to hold received message content.
    - fedmsgPublisher
      
      failOnError : boolean (optional)
      
      Whether you want to fail the build if there is an error sending a message. By default, it is false.
      
      messageContent : String (optional)
      
      Content of CI message to be sent at job completion. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
      
      name : String (optional)
      
      overrides (optional)
      Nested Object
      topic : String (optional)
      
      queue : String (optional)
    - fedmsgSubscriber
      
      checks (optional)
      Array / List of Nested Object
      field : String
      
      expectedValue : String
      
      name : String (optional)
      
      overrides (optional)
      Nested Object
      topic : String (optional)
      
      queue : String (optional)
      
      timeout : int (optional)
      
      Value (in minutes) to wait for a message matching the specified JMS selector.
      
      variable : String (optional)
      
      Environment variable to hold received message content.
    - rabbitMQPublisher
      
      failOnError : boolean (optional)
      
      Whether you want to fail the build if there is an error sending a message. By default, it is false.
      
      fedoraMessaging : boolean (optional)
      
      messageContent : String (optional)
      
      Content of CI message to be sent. Environment variable values may be used in the content to allow customization of the message. Environment variables should use the familiar bash shell format, e.g. ${VARIABLE}.
      
      name : String (optional)
      
      overrides (optional)
      Nested Object
      topic : String (optional)
      
      queue : String (optional)
      
      schema : String (optional)
      
      Path to message schema.
      
      severity : int (optional)
      
      Severity of the message.
    - rabbitMQSubscriber
      
      checks (optional)
      Array / List of Nested Object
      field : String
      
      expectedValue : String
      
      name : String (optional)
      
      overrides (optional)
      Nested Object
      topic : String (optional)
      
      queue : String (optional)
      
      timeout : int (optional)
      
      Value (in minutes) to wait for a message.
      
      variable : String (optional)
      
      Environment variable to hold received message content.
$class: 'CodingPushTrigger'
- webHookToken : String
- apiToken : String
- personalToken : String
- triggerOnMergeRequest : boolean
- mergeRequestTriggerAction : String
- triggerOnPush : boolean
- addResultNote : boolean
- ciSkip : boolean
- branchFilterType
  - Values: All, NameBasedFilter, RegexBasedFilter
- includeBranchesSpec : String
- excludeBranchesSpec : String
- targetBranchRegex : String
$class: 'ComputedFolderWebHookTrigger'
Allows Multibranch Scan Webhook Trigger to trigger scan of this multibranch job.
- token : String
  The token to match with webhook token. Receive any HTTP request, JENKINS_URL/multibranch-webhook-trigger/invoke?token=[Trigger token] If a token match, than a multibranch scan will bi triggered.
$class: 'CronFolderTrigger'
- crontab : String
- enabled : boolean
$class: 'DeployDbTrigger'
If enabled, any webhooks received by Jenkins from a DeployDB instance will be evaluated against the event types configured below.
If the incoming webhook matches one or more of the configured event types, and the service name matches, then a build of this job will be triggered.
Once the execution of a DeployDB-triggered build completes, its status will be reported back to DeployDB.
- silentMode : boolean (optional)
  If enabled, any builds of this job triggered by DeployDB will still be executed, but the result will not be reported back to DeployDB once the build has completed.
- triggerEventTypes (optional)
  - $class: 'DeploymentCompletedEvent'
    serviceNameRegex : String (optional)
    Enter the name of a DeployDB service, or a regular expression, if builds of this job may be triggered by multiple different services.
    If using a regular expression, it must match the entire service name, i.e. "^foo" is not enough to match the service name "foobar".
  - $class: 'DeploymentCreatedEvent'
    serviceNameRegex : String (optional)
    Enter the name of a DeployDB service, or a regular expression, if builds of this job may be triggered by multiple different services.
    If using a regular expression, it must match the entire service name, i.e. "^foo" is not enough to match the service name "foobar".
  - $class: 'DeploymentStartedEvent'
    serviceNameRegex : String (optional)
    Enter the name of a DeployDB service, or a regular expression, if builds of this job may be triggered by multiple different services.
    If using a regular expression, it must match the entire service name, i.e. "^foo" is not enough to match the service name "foobar".
  - $class: 'PromotionCompletedEvent'
    serviceNameRegex : String (optional)
    Enter the name of a DeployDB service, or a regular expression, if builds of this job may be triggered by multiple different services.
    If using a regular expression, it must match the entire service name, i.e. "^foo" is not enough to match the service name "foobar".
$class: 'DockerHubTrigger'
- options (optional)
  - $class: 'TriggerForAllUsedInJob'
  - $class: 'TriggerOnSpecifiedImageNames'
    repoNames : Array / List of String (optional)
$class: 'DosTrigger'
- schedule : String
- script : String
  Enter a DOS script that will be executed periodically.
  A Dos script indicates that a build should be started when the script sets the CAUSE variable to something. e.g:
  
  set CAUSE=Build successfully triggered by dostrigger.
$class: 'ElOyente'
El Oyente (The Listener: Spanish)

Configure a Jenkins job to be triggered on XMPP events.

This plugin integrates XMPP Pub/Sub into Jenkins, which allows jobs to be triggered on XMPP events. XMPP Pub/Sub makes it possible to let distinct services communicate with each other via a pub/sub enabled XMPP chat server.
- s
  - filter : String
  - node : String
  - v
    - envName : String
    - envExpr : String

extendedCron

Provides a cron -like feature to periodically execute this project. To avoid confusion, it should be avoided to use both the Build periodically trigger and this trigger.

cronSpec : String

Trigger runs based on a cron like schedule. You can use the regular Jenkins syntax but also an extended syntax. See the tables below for reference.
The extended syntax has limited support for the H character. It can only be used standalone and not in combination with ranges or intervals.
To specify a different timezone use

TZ=Europe/London

The timezone can appear anywhere in the list, also multiple times and applies to all following lines until a new timezone definition is found.
To reset the TZ information to the controller timezone use

TZ=

Field	Allowed Values	Allowed Special Characters	Comment
Minutes	0-59	, - / H*
Hours	0-23	, - / H*
Day-of-Month	1-31	, - / ? L W H*
Month	1-12 or JAN-DEC	, - / H*	case doesn't matter
Day-of-Week	0-7 SUN-SAT	, - / ? L # H*	0 or 7 is sunday, case doesn't matter

Special Characters

Char	Description
*	Matches all values of the field. E.g. * in the minute field means every minute.
?	Stands for 'no specific value' and is allowed for the Day-of-Month and Day-of-Week fields. It is used instead of the asterisk (*) for leaving either Day-of-Month or Day-of-Week blank.
-	Used to define ranges. E.g., 10-12 in the hour field means the hours of 10, 11, and 12.
,	Used to separate items in a list. E.g., MON,WED,FRI in the Day-of-Week field means the days Monday, Wednesday, and Friday.
/	Used to indicate increments. E.g. 0/20 in the minutes field means the seconds 0, 20 and 40. 1/4 in the Day-of-Month field means every 4 days starting on the first day of the month.
L	Short for "last" and can be used in the Day-of-Month and Day-of-Week fields. The L character has a different meaning in the two fields. In the Day-of-Month field, it means the last day of the month. In the Day-of-Week field, it means 6 or SAT. If used in the Day-of-Week field after a number, it means the last xxx day of the month. E.g., 6L in the Day-of-Week field means the last Saturday of the month.
W	W Stands for "weekday" and is only allowed for the Day-of-Month field. The W character is used to specify the weekday nearest to the given day. E.g., 10W in the Day-of-Month field means the nearest weekday to the 10th of the month. If the 10th is a Saturday, the job will run on Friday the 10th. W can be combined with L to LW and means last weekday of the month.
#	Can only be used in the Day-of-Week field. Used to specify constructs. E.g., 5#3 means the third Friday of the month.
H	Stands for a random value (based on the hash of the job name). Must be used standalone or in combination with a range e.g. H(0-4). In the Day-of-Month field values are chosen in the 1-28 range.

$class: 'FanInReverseBuildTrigger'
Set up a trigger so that when some other projects finish building, a new build is scheduled for this project. This is convenient for running an extensive test after a build is complete, for example.

This configuration complements the "Build other projects" section in the "Post-build Actions" of an upstream project, but is preferable when you want to configure the downstream project.
- upstreamProjects : String
- watchUpstreamRecursively : boolean
- threshold : String
$class: 'FeatureBranchAwareTrigger'
Configure Jenkins to poll changes in SCM.
Note that this is going to be an expensive operation for CVS, as every polling requires Jenkins to scan the entire workspace and verify it with the server. Consider setting up a "push" trigger to avoid this overhead, as described in this document
- scmpoll_spec : String
- ignorePostCommitHooks : boolean (optional)
  Ignore changes notified by SCM post-commit hooks.
  This can be useful if you want to prevent some long-running jobs (e.g. reports) starting because of every commit, but still want to run them periodic if SCM changes have occurred.
  
  Note that this option needs to be supported by the SCM plugin, too! The subversion-plugin supports this since version 1.44.
$class: 'FilesFoundTrigger'
Poll one or more directories and start a build if certain files are found within those directories.
- spec : String
- configs
  - node : String
    The master or slave node on which the search will be performed.
    Environment variable during the build: filesfound_setting_node
  - directory : String
    The directory to poll. A search will be performed within this directory for the relevant files.
    Environment variable during the build: filesfound_setting_directory
  - files : String
    Fileset 'includes' setting that specifies the files to find within the polled directory.
    Environment variable during the build: filesfound_setting_files
  - ignoredFiles : String
    Fileset 'excludes' setting that specifies the files to ignore within the polled directory when deciding whether to trigger a build.
    Environment variable during the build: filesfound_setting_ignoredfiles
  - triggerNumber : String
    The build is triggered when the number of files found is greater than or equal to this number.
    Environment variable during the build: filesfound_setting_triggernumber
$class: 'FogbugzStatePoller'
Provides a cron -like feature to periodically execute this project.
This feature is primarily for using Jenkins as a cron replacement, and it is not ideal for continuously building software projects . When people first start continuous integration, they are often so used to the idea of regularly scheduled builds like nightly/weekly that they use this feature. However, the point of continuous integration is to start a build as soon as a change is made, to provide a quick feedback to the change. To do that you need to hook up SCM change notification to Jenkins .

So, before using this feature, stop and ask yourself if this is really what you want.
- spec : String
- ciProject : String
  This is the name of the CI-project the case should be merged into. It can be filled in in the "ci project" field in fogbugz.
- ciProjectField : String
  This is the name of the field in which the CI-project the case should be merged into is specified. This is the lowercase name of the field, with all non-alphabetical characters replaced by 'x'. For example, if your field is called 'CI Project', you would fill in 'cixproject'. If it is 'Project 123*', you'd fill in 'projectxxxxx'. Please ensure that there are no custom fields in jenkins whose names would be the same with this replacement (e.g. make sure you don't have 'project name 1' and project name 2', as they'd both be 'projectxnamexx').
$class: 'FolderContentTrigger'
- cronTabSpec : String
- path : String
  
  Folder path to poll.
  By default, all files of the specified folder are checked. You can restrict to some files by giving more information in the 'Advanced' section.
- includes : String
- excludes : String
  
  Optionally specify the 'excludes' pattern, such as "foo/bar/**/*". A file that matches this mask will not be polled even if it matches the mask specified in 'includes' section.
- excludeCheckLastModificationDate : boolean
- excludeCheckContent : boolean
- excludeCheckFewerOrMoreFiles : boolean
GenericTrigger
Allows Generic Webhook Trigger to trigger this job.
- genericVariables
  - key : String
  - value : String
  - defaultValue : String (optional)
  - expressionType (optional)
    - Values: XPath, JSONPath
  - regexpFilter : String (optional)
- genericRequestVariables
  - key : String
  - regexpFilter : String
- genericHeaderVariables
  - key : String
  - regexpFilter : String
- allowSeveralTriggersPerBuild : boolean (optional)
- causeString : String (optional)
- overrideQuietPeriod : boolean (optional)
- printContributedVariables : boolean (optional)
- printPostContent : boolean (optional)
- regexpFilterExpression : String (optional)
- regexpFilterText : String (optional)
- shouldNotFlatten : boolean (optional)
- shouldNotFlattern : boolean (optional)
- silentResponse : boolean (optional)
- token : String (optional)
- tokenCredentialId : String (optional)
gerrit
- gerritProjects
  - compareType
    - Values: PLAIN, ANT, REG_EXP
  - pattern : String
  - branches
    - compareType
      Values: PLAIN, ANT, REG_EXP
    - pattern : String
  - topics
    - compareType
      Values: PLAIN, ANT, REG_EXP
    - pattern : String
  - filePaths
    - compareType
      Values: PLAIN, ANT, REG_EXP
    - pattern : String
  - forbiddenFilePaths
    - compareType
      Values: PLAIN, ANT, REG_EXP
    - pattern : String
  - disableStrictForbiddenFileVerification : boolean
  - hashtags (optional)
    - compareType
      Values: PLAIN, ANT, REG_EXP
    - pattern : String
- buildAbortedMessage : String (optional)
- buildCancellationPolicy (optional)
  - abortNewPatchsets : boolean
  - abortManualPatchsets : boolean
  - abortSameTopic : boolean
  - abortAbandonedPatchsets : boolean
- buildFailureMessage : String (optional)
- buildNotBuiltMessage : String (optional)
- buildStartMessage : String (optional)
- buildSuccessfulMessage : String (optional)
- buildUnstableMessage : String (optional)
- buildUnsuccessfulFilepath : String (optional)
- changeSubjectParameterMode (optional)
  How the change subject parameter (GERRIT_CHANGE_SUBJECT) should be added to the build, if available.
  - Human readable (default): Plain text, as it arrives to Jenkins. With quotes escaped if configured above.
  - Encoded (Base64): Base64 encoded string.
  - Do not add: The parameter isn't added to the build at all.
  - Values: PLAIN, BASE64, NONE
- commentTextParameterMode (optional)
  How the comment text parameter (GERRIT_EVENT_COMMENT_TEXT) should be added to the build, if available.
  - Human readable: Plain text, as it arrives to Jenkins. With quotes escaped if configured above.
  - Encoded (Base64) (default): Base64 encoded string.
  - Do not add: The parameter isn't added to the build at all.
  - Values: PLAIN, BASE64, NONE
- commitMessageParameterMode (optional)
  How the commit message parameter (GERRIT_CHANGE_COMMIT_MESSAGE) should be added to the build, if available.
  - Human readable: Plain text, as it arrives to Jenkins. With quotes escaped if configured above.
  - Encoded (Base64) (default): Base64 encoded string.
  - Do not add: The parameter isn't added to the build at all.
  - Values: PLAIN, BASE64, NONE
- customUrl : String (optional)
- dependencyJobsNames : String (optional)
- dynamicTriggerConfiguration : boolean (optional)
- escapeQuotes : boolean (optional)
- gerritBuildAbortedCodeReviewValue : int (optional)
- gerritBuildAbortedVerifiedValue : int (optional)
- gerritBuildFailedCodeReviewValue : int (optional)
- gerritBuildFailedVerifiedValue : int (optional)
- gerritBuildNotBuiltCodeReviewValue : int (optional)
- gerritBuildNotBuiltVerifiedValue : int (optional)
- gerritBuildStartedCodeReviewValue : int (optional)
- gerritBuildStartedVerifiedValue : int (optional)
- gerritBuildSuccessfulCodeReviewValue : int (optional)
- gerritBuildSuccessfulVerifiedValue : int (optional)
- gerritBuildUnstableCodeReviewValue : int (optional)
- gerritBuildUnstableVerifiedValue : int (optional)
- gerritSlaveId : String (optional)
- nameAndEmailParameterMode (optional)
  How the "Compound name and email parameters" should be added to the build. I.e.
  - GERRIT_CHANGE_RESTORER
  - GERRIT_CHANGE_ABANDONER
  - GERRIT_CHANGE_OWNER
  - GERRIT_PATCHSET_UPLOADER
  - GERRIT_EVENT_ACCOUNT
  - Human readable (default): Plain text, as it arrives to Jenkins. With quotes escaped if configured above.
  - Encoded (Base64): Base64 encoded string.
  - Do not add: The parameters aren't added to the build at all.
  - Values: PLAIN, BASE64, NONE
- notificationLevel : String (optional)
- serverName : String (optional)
- silentMode : boolean (optional)
- silentStartMode : boolean (optional)
- skipVote (optional)
  - onSuccessful : boolean
  - onFailed : boolean
  - onUnstable : boolean
  - onNotBuilt : boolean
  - onAborted : boolean
- topicAssociation (optional)
  - ignoreNewChangeStatus : boolean
  - ignoreMergedChangeStatus : boolean
  - ignoreAbandonedChangeStatus : boolean
- triggerConfigURL : String (optional)
- triggerOnEvents (optional)
  - changeAbandoned
  - changeMerged
  - changeRestored
  - commentAddedContains
    commentAddedCommentContains : String
  - commentAdded
    verdictCategory : String
    
    commentAddedTriggerApprovalValue : String
  - draftPublished
  - hashtagChanged
    hashtagChanged : String
  - patchsetCreated
    commitMessageContainsRegEx : String (optional)
    
    excludeDrafts : boolean (optional)
    
    excludeNoCodeChange : boolean (optional)
    
    excludePrivateState : boolean (optional)
    
    excludeTrivialRebase : boolean (optional)
    
    excludeWipState : boolean (optional)
    
    uploaderNameContainsRegEx : String (optional)
  - privateStateChanged
  - refUpdated
  - rerunCheck
  - topicChanged
  - wipStateChanged
$class: 'GhprbTrigger'
- adminlist : String
- whitelist : String
- orgslist : String
- cron : String
- triggerPhrase : String
  When filled, commenting this phrase in the pull request will trigger a build. Matches case insensitively and supports regular expressions (e.g. .*(re)?run tests.*).
- onlyTriggerPhrase : boolean
  When checked, only commenting the trigger phrase in the pull request will trigger a build. All other methods of triggering a pull request build are disabled.
- useGitHubHooks : boolean
  Checking this option will disable regular polling (cron) for changes in GitHub and will try to create a GitHub hook. Creating a GitHub hook requires that the user which is specified in the GitHub Pull Request Builder configuration has admin rights to the specified repository.
  By default, GitHub hooks created this way will have SSL certificate verification enabled. To disable SSL certificate verification in these GitHub hooks, start Jenkins with system property org.jenkinsci.plugins.ghprb.GhprbRepository.webhook.insecure set to true.
  If you want to create a hook manually set it for event types: issue_comment, pull_request and url < your jenkins server url >/ghprbhook/. The url should be composed of your full jenkins server url plus the ending /ghprbhook/ path. If your jenkins server is just a domain like https://jenkins.yourcompany.com then the url would look like https://jenkins.yourcompany.com/ghprbhook/. If your jenkins server is accessed at a path off of a domain like https://yourcompany.com/jenkins then the url would look like https://yourcompany.com/jenkins/ghprbhook/
  . Your Jenkins server must be accessible from internet.
- permitAll : boolean
  This is dangerous!!! With this option enabled everyone can run his own code on your machine!
- autoCloseFailedPullRequests : boolean
- displayBuildErrorsOnDownstreamBuilds : boolean
- commentFilePath : String
- skipBuildPhrase : String
  When filled, adding this phrase to the pull request title or body will not trigger a build.
- blackListCommitAuthor : String
  When filled, pull request commits from this user(s) will not trigger a build. (Note: this can be overridden by job-specific configuration.)
- whiteListTargetBranches
  Adding branches to this whitelist allows you to selectively test pull requests destined for these branches only.
  Supports regular expressions (e.g. 'master', 'feature-.*').
  - branch : String
- blackListTargetBranches
  Adding branches to this blacklist allows you to prevent pull requests for specific branches.
  Supports regular expressions (e.g. 'master', 'feature-.*').
  - branch : String
- allowMembersOfWhitelistedOrgsAsAdmin : boolean
  Use this option to allow members of whitelisted organisations to behave like admins, i.e. whitelist users and trigger pull request testing.
- msgSuccess : String
- msgFailure : String
- commitStatusContext : String
- gitHubAuthId : String
- buildDescTemplate : String
  Set the build description. The default is: <a title=\"$title\" href=\"$url\">PR #$pullId</a>: $abbrTitle
- blackListLabels : String
- whiteListLabels : String
- extensions
  - $class: 'GhprbBuildLog'
    logExcerptLines : int
  - $class: 'GhprbBuildStatus'
    messages
    Global: Sets a default for each job, if the job setup has no entries then this is used.
    
    Add a text message to the comment posted to the pull request on build completion.
    
    Array / List of Nested Object
    result
    Choose either SUCCESS, ERROR, or FAILURE for when the message is appended to the comment that is added to the pull request.
    
    Values: PENDING, SUCCESS, ERROR, FAILURE
    
    message : String
    The message that is appended to a comment when a build finishes with the desired build status. If no status updates should be made when a build finishes with the indicated build status, use "--none--" to alert the trigger.
  - $class: 'GhprbCancelBuildsOnUpdate'
    overrideGlobal : boolean
  - $class: 'GhprbCommentFile'
    commentFilePath : String
    Extends the standard build comment message on github with a custom message file.
  - $class: 'GhprbNoCommitStatus'
  - $class: 'GhprbPublishJenkinsUrl'
    publishedURL : String
    Sometimes Jenkins is set up behind a firewall and normal access is restricted. This URL will be added to a comment appended to the Pull Request.
  - $class: 'GhprbSimpleStatus'
    showMatrixStatus : boolean
    
    commitStatusContext : String
    Context: A string label to differentiate this status from the status of other systems. Default: "default"
    
    statusUrl : String
    Use a custom url instead of the Jenkins job url. If the desired url should be blank, use "--none--" to alert the trigger to use a blank url.
    
    triggeredStatus : String
    Use a custom status for when a build is triggered. If the field is left blank then the default value is used instead. If no status updates should be made when a build is triggered, use "--none--" to alert the trigger.
    
    startedStatus : String
    Use a custom status for when a build is started. If the field is left blank then the default value is used instead. If no status updates should be made when a build is started, use "--none--" to alert the trigger.
    
    addTestResults : boolean
    
    completedStatus
    Use a custom status on the commit for when a build is completed. If the field is left blank then the default value is used instead.
    
    Array / List of Nested Object
    result
    Choose either SUCCESS, ERROR, or FAILURE for when the message is appended to the comment that is added to the pull request.
    
    Values: PENDING, SUCCESS, ERROR, FAILURE
    
    message : String
    The message that is appended to a comment when a build finishes with the desired build status. If no status updates should be made when a build finishes with the indicated build status, use "--none--" to alert the trigger.
- includedRegions : String
  Each inclusion uses regular expression pattern matching, and must be separated by a new line. An empty list implies that everything is included.
  
  myapp/src/main/web/.*\.html myapp/src/main/web/.*\.jpeg myapp/src/main/web/.*\.gif
  
  The example above illustrates that a build will only occur, if html/jpeg/gif files have been committed to the GitHub repository. Exclusions take precedence over inclusions, if there is an overlap between included and excluded regions.
  More information on regular expressions can be found here.
- excludedRegions : String
  Each exclusion uses regular expression pattern matching, and must be separated by a new line.
  
  myapp/src/main/web/.*\.html myapp/src/main/web/.*\.jpeg myapp/src/main/web/.*\.gif
  
  The example above illustrates that if only html/jpeg/gif files have been committed to the GitHub repository a build will not occur.
  More information on regular expressions can be found here.
$class: 'GitBucketPushTrigger'
- passThroughGitCommit : boolean
  This "parameter" passes the SHA1 commit ID into this job, and thereby causes the job to check out the specified commit.
githubBranches
- spec : String
- triggerMode
  Trigger modes.
  
  Cron: Checks for PRs to build periodically.
  
  Hooks: Listens for GitHub webhook events.
  
  Hooks plus Cron: Not fully supported - combines webhooks and cron checks.
  
  Transient Hooks: Not fully supported - listens for GitHub webhook events, does not preserve state for pull requests across runs or Jenkins restarts, etc.
  - Values: CRON, HEAVY_HOOKS, HEAVY_HOOKS_CRON, LIGHT_HOOKS
- events
  GitHub events or statuses that should or should not trigger a build for branch.
  The specified events will be checked in order, and the first to match will be used, so be sure to put events/statuses that should prevent triggering a build first in order.
  If you want to skip PR, you must place skip events firstly.
  - commit
    checks
    Array / List of Nested Choice of Objects
    commitMessagePattern
    
    If set, the plugin will only build revisions commited with messages that match the pattern. If 'skip' is selected, any revisions with matching messages will be ignored.
    
    This can be used to exclude commits done by the build itself from triggering another build, assuming the build server commits the change with a distinct message.
    
    exclude : boolean (optional)
    
    matchCriteria : String (optional)
    Inclusion/Exclusion uses pattern matching
    
    .*\[maven-release-plugin\].*
    The example above illustrates that if only revisions with "[maven-release-plugin]" message in first comment line have been committed to the SCM a build will not occur.
    
    You can create more complex patterns using embedded flag expressions.
    
    (?s).*FOO.*
    This example will search FOO message in all comment lines.
  - branchCreated
  - deleted
  - hashChanged
  - restriction
    exclude : boolean (optional)
    
    matchAsPattern : boolean (optional)
    
    matchCriteriaStr : String (optional)
- abortRunning : boolean (optional)
  If selected, when a new PR build is triggered, if there are already running/building builds/runs for that PR on the executors, they'll be aborted in favor of this most recent build.
- cancelQueued : boolean (optional)
- preStatus : boolean (optional)
- repoProviders (optional)
  - githubPlugin
    cacheConnection : boolean (optional)
    Old trigger behaviour when connection resolved first from global settings and then used locally.
    
    manageHooks : boolean (optional)
    Allow disable registering hooks even if it specified in global settings.
    
    repoPermission (optional)
    ADMIN, PUSH or PULL repository permission required for choosing connection from `GitHub Plugin` `GitHub Server Configs`.
    
    Values: ADMIN, PUSH, PULL
- skipFirstRun : boolean (optional)
  If selected, older, pre-existing PRs will be skipped on the first run of the persistence-based check, and will be marked as seen. Any changes to those PRs after the first check will be treated normally, triggering builds as configured.
githubPullRequests
Trigger that integrates with GitHub Pull Requests and Issues activities and launches runs in response.
- spec : String
- triggerMode
  Trigger modes.
  
  Cron: Checks for PRs to build periodically.
  
  Hooks: Listens for GitHub webhook events.
  
  Hooks plus Cron: Not fully supported - combines webhooks and cron checks.
  
  Transient Hooks: Not fully supported - listens for GitHub webhook events, does not preserve state for pull requests across runs or Jenkins restarts, etc.
  - Values: CRON, HEAVY_HOOKS, HEAVY_HOOKS_CRON, LIGHT_HOOKS
- events
  GitHub events or statuses that should or should not trigger a build of a pull request.
  The specified events will be checked in order, and the first to match will be used, so be sure to put events/statuses that should prevent triggering a build first in order.
  For performance reasons, "Pull Request Opened" should go before other events that require more detailed checking of the pull request, such as "Comment Matched to Pattern". But if you want to skip PR, you must place skip events firstly.
  - close
    Triggers when a pull request is closed. Works only when pull request was opened and closed between persistence-based trigger runs.
  - commentPattern
    Triggers when a comment matching the pattern is posted in a pull request.
    For example Test ([A-Za-z0-9 ,!]+) tags please.
    
    comment : String
  - commitChanged
    Triggers when a previously built pull request's hash has changed from the previous state (i.e., a new commit is pushed, or force-pushed).
  - description
    If given, don't build a pull request if its description contains the given string.
    
    skipMsg : String
  - labelsAdded
    Triggers run when label is added to pull request. Set of labels is considered added only when at least one label of set was newly added (was not saved in local PR previously) AND every label of set exists on remote PR now.
    
    label
    Nested Object
    Help page for GitHubPRLabel class. Not used anywhere?
    
    labels : String
    Every new label on new line
  - labelsExist
    Triggers when all the given labels are on a pull request, or blocks triggering if all the given labels are on a pull request.
    NOTE: This can cause infinite triggers of pull requests when the skip option isn't selected, so be careful.
    
    label
    Nested Object
    Help page for GitHubPRLabel class. Not used anywhere?
    
    labels : String
    Every new label on new line
    
    skip : boolean
  - labelsNotExist
    Triggers or skips triggering when all the given labels are missing from a pull request.
    NOTE: This can cause infinite triggers of pull requests when the skip option isn't selected, so be careful.
    
    label
    Nested Object
    Help page for GitHubPRLabel class. Not used anywhere?
    
    labels : String
    Every new label on new line
    
    skip : boolean
  - labelsPatternExists
    Triggers when a label on a pull request matches the given pattern, or blocks triggering when a label matches, as configured.
    NOTE: This can cause infinite triggers of pull requests when the skip option isn't selected, so be careful.
    
    label
    Nested Object
    Help page for GitHubPRLabel class. Not used anywhere?
    
    labels : String
    Every new label on new line
    
    skip : boolean
  - labelsRemoved
    Triggers a build when the label or labels specified are removed from a pull request. Note that with multiple labels, all of the labels must be removed to cause the trigger to fire.
    
    label
    Nested Object
    Help page for GitHubPRLabel class. Not used anywhere?
    
    labels : String
    Every new label on new line
  - nonMergeable
    skip : boolean
  - Number
    number : int
    PR number to run additional checks against
    
    match : boolean
    Defines whether the pull request number in the trigger event must match to the above PR number. If not, then logic is not applied and the event wouldn't influence on the trigger result.
    
    skip : boolean
    Defines whether a matching or non matching pull request number in the trigger event, depending on the above "Match number" flag, skips building instead of triggering a build.
  - Open
    Triggers a build of a pull request when the pull request is opened or reopened.
- abortRunning : boolean (optional)
  If selected, when a new PR build is triggered, if there are already running/building builds/runs for that PR on the executors, they'll be aborted in favor of this most recent build.
- branchRestriction (optional)
  Limit job run to certain branch matches.
  - targetBranch : String
- cancelQueued : boolean (optional)
  If selected, when a new PR build is triggered, if there are already pending builds for that PR in the queue, they'll be removed from the queue in favor of this most recent build.
- preStatus : boolean (optional)
  Updates the GitHub pull request's status to PENDING once the build for that pull request has been queued to run.
- repoProviders (optional)
  - githubPlugin
    cacheConnection : boolean (optional)
    Old trigger behaviour when connection resolved first from global settings and then used locally.
    
    manageHooks : boolean (optional)
    Allow disable registering hooks even if it specified in global settings.
    
    repoPermission (optional)
    ADMIN, PUSH or PULL repository permission required for choosing connection from `GitHub Plugin` `GitHub Server Configs`.
    
    Values: ADMIN, PUSH, PULL
- skipFirstRun : boolean (optional)
  If selected, older, pre-existing PRs will be skipped on the first run of the persistence-based check, and will be marked as seen. Any changes to those PRs after the first check will be treated normally, triggering builds as configured.
- userRestriction (optional)
  Adds ability to restrict who is allowed to run and whitelist users/orgs. Users can be updated with special comment from allowed users/orgs.
  - orgs : String
  - users : String
githubPush
When Jenkins receives a GitHub push hook, GitHub Plugin checks to see whether the hook came from a GitHub repository which matches the Git repository defined in SCM/Git section of this job. If they match and this option is enabled, GitHub Plugin triggers a one-time polling on GITScm. When GITScm polls GitHub, it finds that there is a change and initiates a build. The last sentence describes the behavior of Git plugin, thus the polling and initiating the build is not a part of GitHub plugin.
gitlab
Options for triggering Jenkins jobs based on GitLab events.
- acceptMergeRequestOnSuccess : boolean (optional)
- addCiMessage : boolean (optional)
- addNoteOnMergeRequest : boolean (optional)
- addVoteOnMergeRequest : boolean (optional)
- branchFilterName : String (optional)
- branchFilterType (optional)
  - Values: All, NameBasedFilter, RegexBasedFilter
- cancelPendingBuildsOnUpdate : boolean (optional)
  If enabled, then pending builds will be canceled when a merge request is updated in the GitLab repository.
- ciSkip : boolean (optional)
  If enabled, then the build will be skipped when a GitLab comment includes the text ci-skip.
- excludeBranchesSpec : String (optional)
- includeBranchesSpec : String (optional)
- labelsThatForcesBuildIfAdded : String (optional)
- mergeRequestLabelFilterConfig (optional)
  - exclude : String (optional)
  - include : String (optional)
- noteRegex : String (optional)
- pendingBuildName : String (optional)
- secretToken : String (optional)
- setBuildDescription : boolean (optional)
  If enabled, then the build Jenkins description will be updated with the build cause.
- skipWorkInProgressMergeRequest : boolean (optional)
  If enabled, then the build will be skipped when a GitLab merge request is a work in progress.
- sourceBranchRegex : String (optional)
- targetBranchRegex : String (optional)
- triggerOnAcceptedMergeRequest : boolean (optional)
  If enabled, then the build will be triggered when a merge request is accepted in the GitLab repository.
- triggerOnApprovedMergeRequest : boolean (optional)
  If enabled, then the build will be triggered when a merge request is approved on the GitLab Enterprise Edition repository.
- triggerOnClosedMergeRequest : boolean (optional)
  If enabled, then the build will be triggered when merge requests are closed in the GitLab repository.
- triggerOnMergeRequest : boolean (optional)
  If enabled, then the build will be triggered when a merge request is created in the GitLab repository.
- triggerOnNoteRequest : boolean (optional)
  If enabled, then the build will be triggered when a comment is added to the GitLab repository.
- triggerOnPipelineEvent : boolean (optional)
- triggerOnPush : boolean (optional)
  If enabled, then the build will be triggered when new commits are pushed to the GitLab repository.
- triggerOnlyIfNewCommitsPushed : boolean (optional)
  If enabled, then the build will be triggered when new commits are pushed to the GitLab repository.
- triggerOpenMergeRequestOnPush (optional)
  If enabled, then the build will be triggered when changes are made to open merge requests in the GitLab repository.
  - Values: never, source, both
- triggerToBranchDeleteRequest : boolean (optional)
  If enabled, then the build will be triggered when a branch is deleted from the GitLab repository.
gitee
- acceptPullRequestOnSuccess : boolean (optional)
- addCiMessage : boolean (optional)
- addNoteOnPullRequest : boolean (optional)
- addVoteOnPullRequest : boolean (optional)
- branchFilterName : String (optional)
- branchFilterType (optional)
  - Values: All, NameBasedFilter, RegexBasedFilter
- buildInstructionFilterType (optional)
  - Values: NONE, CI_SKIP, CI_BUILD
- cancelIncompleteBuildOnSamePullRequest : boolean (optional)
- cancelPendingBuildsOnUpdate : boolean (optional)
- ciBuildForDeleteRef : boolean (optional)
- ciSkip : boolean (optional)
- ciSkipFroTestNotRequired : boolean (optional)
- excludeBranchesSpec : String (optional)
- ignorePullRequestConflicts : boolean (optional)
- includeBranchesSpec : String (optional)
- noteRegex : String (optional)
- pendingBuildName : String (optional)
- pullRequestLabelFilterConfig (optional)
  - exclude : String (optional)
  - include : String (optional)
- secretToken : String (optional)
- setBuildDescription : boolean (optional)
- skipLastCommitHasBeenBuild : boolean (optional)
- skipWorkInProgressPullRequest : boolean (optional)
- targetBranchRegex : String (optional)
- triggerOnAcceptedPullRequest : boolean (optional)
- triggerOnApprovedPullRequest : boolean (optional)
- triggerOnClosedPullRequest : boolean (optional)
- triggerOnCommitComment : boolean (optional)
- triggerOnNoteRequest : boolean (optional)
- triggerOnOpenPullRequest : boolean (optional)
- triggerOnPipelineEvent : boolean (optional)
- triggerOnPush : boolean (optional)
- triggerOnTestedPullRequest : boolean (optional)
- triggerOnUpdatePullRequest : String (optional)
$class: 'GitlabBuildTrigger'
- cron : String
- projectPath : String
  
  The project path on Gitlab. You can find the project path in the project SSH or HTTP path. For example, in "http://example.com/group/project.git", the project path would be "group/project".
- targetBranchRegex : String
  The target branch regex is used to allow execution of this job for certain branches. The regex will be not used when this field is left empty.
  
  Examples:
  
  # Allow execution for release and hotfix branches (.*release.*|.*hotfix.*) # Allow execution for dev branches only .*dev.*
- useHttpUrl : boolean
- assigneeFilter : String
- tagFilter : String
- triggerComment : String
- autoCloseFailed : boolean
- autoMergePassed : boolean
$class: 'GogsTrigger'
$class: 'HudsonStartupTrigger'
- label : String
  
  By default, the build is triggered when Jenkins instance starts.
  You can specify a specific (or a list of) node name or a node label to trigger a build when nodes (whose names or labels corresponding to the specified value) start.
  You can also specify the 'master' value to refer explicitly to Jenkins master.
- quietPeriod : String
  
  Give the quiet period before scheduling the job.
  The time unit is in seconds.
  '0' is the default value, the job is scheduling without any delay at startup.
- nodeParameterName : String
  
  Pass node name as job parameter.
  Requires NodeLabel Parameter Plugin
- runOnChoice : String
  
  Run on initial connection
  Toggle whether or not to run the job when agent connects to Jenkins (True by default)
  
  Run when node brought online
  Toggle whether to run the job when node is brought online (False by default)
issueCommentTrigger
- commentPattern : String
$class: 'IvyTrigger'
- cronTabSpec : String
- ivyPath : String
  The path of an ivy file.
  It can be absolute or relative to the workspace of the latest build.
- ivySettingsPath : String
  The path of an ivySetting.xml file.
  It can be absolute or relative to the workspace of the latest build or an URL to retrieve the settings from.
- propertiesFilePath : String
  One or more properties file path(s).
  Separate file paths with a semi-colon.
  Properties will be injected as variables into the ivy settings file.
- propertiesContent : String
  Properties content.
  Properties will be injected as variables in the ivy settings file.
- labelRestriction
  - triggerLabel : String
- enableConcurrentBuild : boolean
- debug : boolean
- downloadArtifacts : boolean
  Whether or not to download the artifacts within a dependency.
  If this is false, then much less disk space is used. However a change in the artifacts, or the addition or removal of artifacts, of a dependency that does not also cause a version number change in the dependency, will not be detected.

$class: 'JiraChangelogTrigger'

Set up a trigger that listens to JIRA issue changes. See plugin documentation setup section before using this trigger.

changelogMatchers (optional)
- $class: 'CustomFieldChangelogMatcher'
  Matches custom field changes in the updated JIRA issue.
  - field : String
    The custom field name that has been changed during the issue update. This refers to custom field name, so it should not be in customfield_* format. This field is case sensitive.
  - newValue : String
    The new value of the updated field.
  - oldValue : String
    The old value of the updated field, meaning the value before it is updated.
  - comparingNewValue : boolean (optional)
    Tick this if you want this matcher to compare the new value of the updated field. New value changes will be ignored otherwise.
  - comparingOldValue : boolean (optional)
    Tick this if you want this matcher to compare the old value of the updated field. Old value changes will be ignored otherwise.
- $class: 'JiraFieldChangelogMatcher'
  Matches JIRA built-in field changes in the updated JIRA issue.
  - field : String
    The JIRA Field ID that has been changed during the issue update. Select one from the combo box below or type the ID if it's not available in the combo box.
  - newValue : String
    The new value of the updated field.
  - oldValue : String
    The old value of the updated field, meaning the value before it is updated.
  - comparingNewValue : boolean (optional)
    Tick this if you want this matcher to compare the new value of the updated field. New value changes will be ignored otherwise.
  - comparingOldValue : boolean (optional)
    Tick this if you want this matcher to compare the old value of the updated field. Old value changes will be ignored otherwise.
jqlFilter : String (optional)
A build will only be triggered if the updated issues matches this JQL filter. The updated issues in this particular case are the issues where the comments have been added in.

parameterMappings (optional)

Maps JIRA issue attributes as Jenkins parameters. Can be used when this job is parameterized.

Array / List of Nested Choice of Objects

$class: 'CustomFieldParameterMapping'
- jenkinsParameter : String
  The Jenkins parameter name that will be filled in with the JIRA attribute value resolves from the attribute path.
- customFieldId : String
  The custom field id to be mapped (not the name). This field must contain numbers only e.g. 10000, 10020, etc.

$class: 'IssueAttributePathParameterMapping'

JIRA attribute path resolves an attribute value from the JIRA issue that has triggered the job. The attribute value is resolved from JRJC Issue Object To understand how the attribute path works, refer to the example below.

Example attribute path

Attribute Path	Attribute Value
id	11120
description	description body
summary	summary content
status.name	To Do
timeTracking.originalEstimateMinutes	5

Example Issue JSON that will be parsed to become JRJC Issue Object

{
  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog,versionedRepresentations",
  "id": "11120",
  "self": "http://localhost:2990/jira/rest/api/2/issue/11120",
  "key": "TEST-136",
  "fields": {
    ...
    "description": "description body",
    "summary": "summary content",
    ...
    "status": {
      "name": "To Do",
        ...
    },
    "timetracking": {
      "originalEstimate": "5m",
      "remainingEstimate": "10m",
      "originalEstimateSeconds": 300,
      "remainingEstimateSeconds": 600
    }
  }
}

jenkinsParameter : String
The Jenkins parameter name that will be filled in with the JIRA attribute value resolves from the attribute path.
issueAttributePath : String

$class: 'JiraCommentTrigger'

Set up a trigger so that when a comment is added to JIRA. See plugin documentation setup section before using this trigger.

commentPattern : String (optional)
Triggers build only when the comment added to JIRA matches this pattern.
jqlFilter : String (optional)
A build will only be triggered if the updated issues matches this JQL filter. The updated issues in this particular case are the issues where the comments have been added in.

parameterMappings (optional)

Maps JIRA issue attributes as Jenkins parameters. Can be used when this job is parameterized.

Array / List of Nested Choice of Objects

$class: 'CustomFieldParameterMapping'
- jenkinsParameter : String
  The Jenkins parameter name that will be filled in with the JIRA attribute value resolves from the attribute path.
- customFieldId : String
  The custom field id to be mapped (not the name). This field must contain numbers only e.g. 10000, 10020, etc.

$class: 'IssueAttributePathParameterMapping'

Example attribute path

Attribute Path	Attribute Value
id	11120
description	description body
summary	summary content
status.name	To Do
timeTracking.originalEstimateMinutes	5

Example Issue JSON that will be parsed to become JRJC Issue Object

{
  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog,versionedRepresentations",
  "id": "11120",
  "self": "http://localhost:2990/jira/rest/api/2/issue/11120",
  "key": "TEST-136",
  "fields": {
    ...
    "description": "description body",
    "summary": "summary content",
    ...
    "status": {
      "name": "To Do",
        ...
    },
    "timetracking": {
      "originalEstimate": "5m",
      "remainingEstimate": "10m",
      "originalEstimateSeconds": 300,
      "remainingEstimateSeconds": 600
    }
  }
}

jenkinsParameter : String
The Jenkins parameter name that will be filled in with the JIRA attribute value resolves from the attribute path.
issueAttributePath : String

$class: 'KanboardQueryTrigger'
- crontabSpec : String
- projectIdentifier : String
- query : String
  Official Kanboard advanced search syntax documentation
- referenceRegexp : String
  The trigger will only activate for tasks whose reference matches the regular expression. No filtering will be done if left blank.
  
  The eventual regexp matching groups will be exported to the KANBOARD_TASKREF_{index of group} environment variables.
  
  For example:
  
  The regular expression ([A-Z]+)-([0-9]+) will match the reference ABC-12345 and will export the following environment variables:
  
  KANBOARD_TASKREF=ABC-12345
  
  KANBOARD_TASKREF_0=ABC
  
  KANBOARD_TASKREF_1=12345
labelAddedTrigger
- labelTriggerPattern : String
$class: 'LabeledFilterWebHookTrigger'
$class: 'MailCommandTrigger'
To pool arriving e-mail that CLI command is written.
- spec : String
$class: 'MavenDependencyUpdateTrigger'
- cron_value : String
- checkPlugins : boolean
$class: 'NugetTrigger'
- cronTabSpec : String
- checkPrerelease : boolean
- useVerboseLogs : boolean
ontrackMultiTrigger
- spec : String
- triggers
  - project : String
  - branch : String
  - promotion : String
  - parameterName : String
  - minimumResult : String
ontrackTrigger
- spec : String
  CRON spec defining the schedule at which a new promotion will be checked.
- project : String
  Name of the Ontrack project to check.
- branch : String
  Name of the Ontrack branch to check.
- promotion : String
  Name of the Ontrack promotion to check.
  
  Possible values are:
  
  Blank - last build, with or without promotion
  
  * - last promoted build
  
  X - last build promoted to X
- parameterName : String
  Name of the parameter which contains the name of the build.
- minimumResult : String
  Define the minimum required quality of the previous run
  This value is only used in case there is no new version to build, but the previous run failed:
  If set to:
  
  SUCCESS: the build will rerun if the previous result was worse than SUCCESS
  
  UNSTABLE: the build will rerun if the previous result was worse than UNSTABLE
  
  FAILURE: the build will rerun if the previous result was worse than FAILURE
p4Trigger
parameterizedCron
Adds support for passing parameters to parameterized builds on top of the default scheduler.
- parameterizedSpecification : String
  follow convention of cron, schedule with name=value pairs at the end of each line.
  Everything up till the % character is just like the normal Jenkins Cron-like scheduler. Then after the % character you should format your parameters as name value pairs separated by equals and semicolons: name=value;othername=othervalue
  
  There are of course limitations to what can be passed as parameters. As well as what types of parameters can be assigned. The internal mechanism leans on the same HTTP POST request method for triggering builds as documented in Launching a build with parameters.
  
  don't use semi-colons in the values
  
  don't use equals in the values
  
  This is a first step toward solving this Jenkins issue.
  
  Examples:
  
  # every fifteen minutes (perhaps at :07, :22, :37, :52) H/15 * * * * %name=value # every ten minutes in the first half of every hour (three times, perhaps at :04, :14, :24) H(0-29)/10 * * * * % name=value; othername=othervalue # every fifteen minutes with timezone TZ=Australia/Sydney H/15 * * * * %name=value # every fifteen minutes with percent sign in param key/value H/15 * * * * %name=value;key=10%;
$class: 'PeriodicFolderTrigger'
Some kinds of folders are reindexed automatically and immediately upon receipt of an external event. For example, a multi-branch project will recheck its SCM repository for new or removed or modified branches when it receives an SCM change notification. (Push notification may be configured as per the SCM plugin used for each respective branch source.) Such notifications can occasionally be unreliable, however, or Jenkins might not even be running to receive them. In some cases no immediate notification is even possible, for example because Jenkins is behind a firewall and can only poll an external system.

This trigger allows for a periodic fallback, but when necessary. If no indexing has been performed in the specified interval, then an indexing will be scheduled. For example, in the case of a multi-branch project, if the source control system is not configured for push notification, set a short interval (most people will pick between 15 minutes and 1 hour). If the source control system is configured for push notification, set an interval that corresponds to the maximum acceptable delay in the event of a lost push notification as the last commit of the day. (Subsequent commits should trigger indexing anyway and result in the commit being picked up, so most people will pick between 4 hours and 1 day.)
- interval : String
  
  The maximum amount of time since the last indexing that is allowed to elapse before an indexing is triggered. For example: interval('5m') // or '2h', '7d', '5000ms', '60s'
acmPipelineStart
- aioProject : String
- program : String
- pipeline : String
$class: 'PollMailboxTrigger'
- cronTabSpec : String
- labelRestriction
  - triggerLabel : String
- enableConcurrentBuild : boolean
  Enable concurrent build.
  By default, polling process waits for the end of the build.
  Check this option enables you trigger concurrent builds such as 10 builds at a time.
- host : String
  The Host field, allows you to enter the DNS name/hostname/IP Address of the server, hosting the email account service.
- username : String
  The Username field, allows you to enter the username required to connect to this email account.
- password
  The Password field, allows you to enter the password (N.B. or application password) required to connect to this email account.
  - Type: class hudson.util.Secret
- script : String
  The Advanced Email Properties field, allows you to configure the plugin, using standard key=value property notation.
  
  You can override the following default property values:
  
  # Connection configuration storeName=imaps # Search configuration folder=INBOX subjectContains=jenkins > receivedXMinutesAgo=1440 # JavaMail configuration mail.debug=true mail.debug.auth=true mail.imaps.host=<above_host> mail.imaps.port=993
  
  You can also add java imap properties, to further configure the connection.
- attachments : String
  The Attachments field, allows you to determine what to do with email attachments. If attachments are downloaded, the pmt_attachmentsDirectory variable with be set to the download directory.
$class: 'PromotionTrigger'
- jobName : String
- process : String
$class: 'PullRequestBuildTrigger'
The following will be performed for this job:
- Configure Git to check out source code for the pull request if Git is selected in Source Code Management section of this job and not yet configured.
- A build of this job will be triggered every time a pull request is updated or created.
- Cancel older in-progress builds of a pull request when a new build for that same pull request is scheduled.
- Instances deployed by ElasticBox - Deploy Box build step for a pull request in this job or its downstream jobs will be terminated and deleted after the pull request is merged or closed.
The following parameters are available to the triggered build:
- PR_NUMBER - Pull request number
- PR_URL - Pull request URL (e.g. https://github.com/jenkinsci/elasticbox-plugin/pull/1)
- PR_OWNER - GitHub login of the pull request owner
- PR_OWNER_EMAIL - Pull request owner's email address
- PR_MERGE_BRANCH - Branch that the pull request wants to be merged to (e.g. master)
- PR_BRANCH - Git branch of the pull request (e.g. fix-unit-tests)
- PR_COMMIT - Git commit for the triggered build (e.g. fe982b7082035025bef4e851b5bd250a21aae18e)
- PR_TITLE - Pull request title
- BUILD_REQUESTER - GitHub login of the person requesting this build via a trigger phrase like “Jenkins test this please”
- BUILD_REQUESTER_EMAIL - Email address of the build requester
- triggerPhrase : String
  Phrase in Java regular expression. Commenting this phrase in the pull request will trigger a build. You can't trigger build with comment if this field is blank.
- whitelist : String
  Comma-separate list of users and/or organizations that can trigger builds for pull requests. If this list is empty, everyone can trigger pull request builds.
pullRequestReview
- reviewStates : Array / List of String (optional)
$class: 'QuayIoTrigger'
- repositories : Array / List of String (optional)
  List of repositories which will trigger the job (whitespace separated)
$class: 'RemoteBuildResultTrigger'
- cronTabSpec : String
- remoteJobInfos
  - id : String (optional)
  - remoteJobName : String (optional)
    
    If project is Multibranch Pipeline or in folder, Remote Job Name should be full path: job/{xxx}/job/{xxx}
  - remoteServer : String (optional)
    The remote Jenkins as configured in the Jenkins global configuration (Manage Jenkins > Configure System > Remote Result Trigger Configuration > Remote Jenkins Server).
  - resultChecks (optional)
    - key : String
    - expectedValue : String
  - triggerResults : Array / List of boolean (optional)
  - uid : String (optional)
    The Unique Identifier(Optional) only used to replace injected envs, like env REMOTE_${uid}_BUILD_NUMBER.If didn't set, it will be replace with Remote Job Name
$class: 'RemoteBuildTrigger'
- remoteBuildToken : String
  
  Remote build token.
  
  You can set token string for remote build. Build will be triggered if application message has the same token in token attribute.
upstream
Set up a trigger so that when some other projects finish building, a new build is scheduled for this project. This is convenient for running an extensive test after a build is complete, for example.

This configuration complements the "Build other projects" section in the "Post-build Actions" of an upstream project, but is preferable when you want to configure the downstream project.
- upstreamProjects : String
- threshold : String (optional)
$class: 'RundeckTrigger'
- filterJobs : boolean
  Only triggers a new build if the Rundeck execution at the origin of the notification matches one of the following Rundeck job.
- jobsIdentifiers : Array / List of String
- executionStatuses : Array / List of String
  Only triggers a build if the status of the Rundeck execution at the origin of the notification matches one of the checked statuses.
- token
  - Type: class hudson.util.Secret
pollSCM
Configure Jenkins to poll changes in SCM.
Note that this is going to be an expensive operation for CVS, as every polling requires Jenkins to scan the entire workspace and verify it with the server. Consider setting up a "push" trigger to avoid this overhead, as described in this document
- scmpoll_spec : String
- ignorePostCommitHooks : boolean (optional)
  Ignore changes notified by SCM post-commit hooks.
  This can be useful if you want to prevent some long-running jobs (e.g. reports) starting because of every commit, but still want to run them periodic if SCM changes have occurred.
  
  Note that this option needs to be supported by the SCM plugin, too! The subversion-plugin supports this since version 1.44.
$class: 'SpaceWebhookTrigger'
Triggers the build on changes to a git repository or merge request in JetBrains SpaceCode.

This trigger relies on the webhooks that are set up on the JetBrains SpaceCode side automatically according to the trigger condition and filters you specify.
- id : String
- repositoryName : String
- allowSafeMergeWithBranches : boolean
  
  Allows using the build for safe merge of a merge request in JetBrains SpaceCode.
  
  Safe merge lets you execute quality checks for a merge request on a temporary merge commit before actually integrating the merge request into the main branch. See the JetBrains SpaceCode documentation for more information about safe merge.
- allowSafeMergeWithMergeRequests : boolean
  
  Allows using the build for safe merge of a merge request in SpaceCode.
  
  Safe merge lets you execute quality checks for the merge request on the merge commit in the temporary merge branch, before actually integrating the merge request into the main branch. See SpaceCode documentation for more information about safe merge.
- branchSpec : String (optional)
  Reference branches in the format "+|-:". Use + to include and - to exclude branches. Use * as a wildcard. Use ; to separate branches.
- mergeRequestApprovalsRequired : boolean (optional)
  
  Merge request must be approved by all invited reviewers to trigger the build.
  
  The list of reviewers shouldn't be empty. The build will get triggered as soon as the last reviewer approves merge request. The build will also get triggered for each subsequent push to the merge request source branch, provided that all the reviewers have finalized their approval (the approval won't get reset on new commits).
- mergeRequestSourceBranchSpec : String (optional)
  
  Merge request source branch must match the specified branches.
  
  Reference branches in the format "+|-:". Use + to include and - to exclude branches. Use * as a wildcard. Use ; to separate branches.
- mergeRequestTitleRegex : String (optional)
  
  Merge request title must match the specified regular expression.
  
  A build will be triggered on any new commits in a merge request if its title is matching the regular expression. A build will also get triggered for a non-matching merge request whenever the merge request title changes so that it starts matching the expression.
  
  Regular expression must match the entire merge request title, not just a part of it. For example, to exclude all merge requests with a title starting with "WIP" from triggering builds, specify (?!WIP).+ as a regex.
- triggerType (optional)
  - Values: Branches, MergeRequests, OnlySafeMerge
$class: 'SpoonTrigger'
- repositoryUrl : String
  When a webhook event is received by Jenkins it will use repository URL to find out which jobs to schedule.
$class: 'SqsTrigger'
Config the AWS SQS queue to watch.
- sqsDisableConcurrentBuilds : boolean (optional)
  If checked, and there's build running, skip build(s) when message received.
  If checked, and there's no running job but multiple messages are received in one SQS call, only the (random) first message is selected to trigger the build and others are ignored.
  If un-checked, each message triggers one build.
- sqsTriggerCredentialsId : String (optional)
  The AWS Credentials to be used. Leave it blank if retrieving credentials from environment variables, instance profile or IRSA.
- sqsTriggerQueueUrl : String (optional)
  The SQS queue name to watch.
$class: 'StashBuildTrigger'
Configure Jenkins to check a repository in Stash (Bitbucket Server) for pull requests and trigger a build when a new pull request is posted or an existing pull request is updated. The build result is posted to Stash as a comment.
- cron : String
  Specify how often Stash REST API should be polled for pull requests. For instance, H/2 * * * * would make Jenkins poll Stash every 2 minutes.
- stashHost : String
  The http or https URL of the Stash server REST API.
  NOTE: This is not the git clone URL.
  Example: https://stash.example.com/
- credentialsId : String
  Credentials for accessing the Stash REST API host. This is not an ssh key.
- projectCode : String
  Project key (abbreviated name) in Stash, e.g. PRJ or ~username
- repositoryName : String
  Name of the repository to be monitored in Stash
- cancelOutdatedJobsEnabled : boolean (optional)
  When starting the PR build, cancel all jobs in the queue for the same PR. Also abort currently running jobs for that PR.
- checkDestinationCommit : boolean (optional)
  Start the build if the destination commit has changed, i.e. some changes have been made on the target branch.
- checkMergeable : boolean (optional)
  Build the PR only if Stash considers it mergeable. Please note that if the PR doesn't have the required number of approvals, it would be considered non-mergeable and would not be tested when this option is enabled.
- checkNotConflicted : boolean (optional)
  Don't build the PR if Stash reports it to be in the conflict state. This must be used if using the merge refspec. Stash 2.9+ doesn't provide the merge refspec for conflicted PRs, so Jenkins could end up testing an older version of the PR.
- checkProbeMergeStatus : boolean (optional)
  Probe the Stash REST API for merge status just so it recalculates the refspec: this just causes the plugin to send a request to the Stash REST API endpoint which triggers recalculation of Git refspecs. Unlike the "Build only if..." options, this one has no impact on proceeding with the build itself.
  Use this if you encounter problems with stale commits being built, but don't want to skip builds based on the PR status (as would be the case with the "Build only if Stash reports no conflicts" or "Build only if Stash reports PR is mergeable" options). Also note that this option does not have any special effect if you have enabled one of those two options.
  Normally Stash has a "lazy" recalculation, after a request to do so (which may be part of Stash Web-UI processing among other things), in order to avoid server load spikes whenever a source or target branch of a pull request changes.
  For more details see JENKINS-35219 issue and Atlassian discussion for details).
- ciBuildPhrases : String (optional)
  Build the PR if the specified phrase has been posted as a PR comment in Stash, even if the PR has not changed.
  The phrase should be a substring of the comment. The case is ignored. For instance, "Test this please, Jenkins!" would match the default setting.
  Default: test this please
- ciSkipPhrases : String (optional)
  Do not build the PR if the specified phrase has been posted in a PR comment. Multiple comma-separated phrases are supported.
  Default: NO TEST
- deletePreviousBuildFinishComments : boolean (optional)
  Delete old comments about finished PR builds when starting a new build.
- ignoreSsl : boolean (optional)
  Allow invalid or unverifiable (e.g. self-signed) https certificates for Stash REST API access.
- mergeOnSuccess : boolean (optional)
  Tell Stash to merge the PR automatically if the build job has been successful.
- onlyBuildOnComment : boolean (optional)
  Only trigger the build when the build phrase has been posted. Don't trigger the build for other reasons, e.g. when a new PR is found or when a PR is updated.
- targetBranchesToBuild : String (optional)
  Only consider pull requests targeting specific branches. If empty, all branches are considered. Use a comma separated list of regular expressions, e.g. master,release/.*
TeamsTrigger
Allows Teams Webhook Trigger to trigger this job.
- genericVariables
  - key : String
  - value : String
  - defaultValue : String (optional)
  - expressionType (optional)
    - Values: XPath, JSONPath, StringPart
  - regexpFilter : String (optional)
- regexpFilterText : String
- regexpFilterExpression : String
- genericRequestVariables
  - key : String
  - regexpFilter : String
- genericHeaderVariables
  - key : String
  - regexpFilter : String
- causeString : String (optional)
- overrideQuietPeriod : boolean (optional)
- printContributedVariables : boolean (optional)
- printPostContent : boolean (optional)
- silentResponse : boolean (optional)
- textSeparator : String (optional)
- token : String (optional)
- tokenCredentialId : String (optional)
- valuesFromTextKey : boolean (optional)
cron
Provides a cron -like feature to periodically execute this project.
This feature is primarily for using Jenkins as a cron replacement, and it is not ideal for continuously building software projects . When people first start continuous integration, they are often so used to the idea of regularly scheduled builds like nightly/weekly that they use this feature. However, the point of continuous integration is to start a build as soon as a change is made, to provide a quick feedback to the change. To do that you need to hook up SCM change notification to Jenkins .

So, before using this feature, stop and ask yourself if this is really what you want.
- spec : String
URLTrigger
- cronTabSpec : String
- triggerLabel : String
- entries (optional)
  - url : String
  - checkETag : boolean (optional)
  - checkLastModificationDate : boolean (optional)
  - checkStatus : boolean (optional)
  - contentTypes (optional)
    - JsonContent
      
      jsonPaths
      Array / List of Nested Object
      jsonPath : String
    - MD5Sum
    - TextContent
      
      regExElements
      Array / List of Nested Object
      regEx : String
    - XMLContent
      
      xPaths
      Array / List of Nested Object
      xPath : String
  - inspectingContent : boolean (optional)
  - password : String (optional)
  - proxyActivated : boolean (optional)
  - requestHeaders (optional)
    - headerName : String (optional)
    - headerValue : String (optional)
  - statusCode : int (optional)
  - timeout : int (optional)
  - useGlobalEnvVars : boolean (optional)
  - username : String (optional)
- labelRestriction : boolean (optional)
snapshotDependencies
Trigger the build of this pipeline when a Maven SNAPSHOT dependency is built by this Jenkins instance. Jenkins discovers all the dependencies of the Maven builds of this pipeline invoked in a withMaven(){...} wrapping step and will trigger the build if one of these dependencies has been built (typically a SNAPSHOT version). This is convenient for automatically performing continuous integration. Jenkins will check the snapshot dependencies from the <dependency> element in the POM.
$class: 'com.ribose.jenkins.plugin.awscodecommittrigger.SQSTrigger'
Configure Jenkins to monitor an Amazon SQS queue for CodeCommit SNS messages. Jenkins will start a new build if (AND if):
- message is posted to the queue
- message match against any repo links configured in section Subscribe to CodeCommit Repo
Available queues can be configured in the System Configuration of Jenkins.

Further documentation is available in the GitHub
- queueUuid : String
  The Amazon SQS queue to monitor for messages.
- subscribeInternalScm : boolean
- sqsScmConfigs
  - type : String
  - url : String
  - subscribedBranches : String
    Possible options, see more Jenkins Git plugin:
    
    <branchName>
    Tracks the specified branch. Better use refs/heads/<branchName>
    E.g. master , development
    
    Multiple branches
    Tracks multiple branches in csv format
    E.g. development, master, */master, *feature, feature/**
    
    Any branch
    E.g. **
    
    <Wildcards>
    
    "*" is recognized as a wildcard
    
    "**" is recognized as wildcard that includes the separator '/'
    
    Therefore, origin/branches* would match origin/branches-foo but not origin/branches/foo, while origin/branches** would match both origin/branches-foo and origin/branches/foo
$class: 'io.relution.jenkins.scmsqs.SQSTrigger'
Configure Jenkins to monitor an Amazon SQS queue for messages. Jenkins will start a new build if a message is posted to the queue and the message's content matches this job's repository and branch. The repository should be set up to post messages to the queue whenever changes are made.
Available queues can be configured in the System Configuration of Jenkins.
Further documentation is available in the SCM SQS Plugin repository on GitHub.
- queueUuid : String
  The Amazon SQS queue to monitor for messages.
$class: 'org.jenkinsci.plugins.deploy.weblogic.trigger.DeploymentTrigger'
Execute this project periodically (dedicated to the weblogic deployment).
- schedule : String
  This field accepts the cron syntax
$class: 'org.jenkinsci.plugins.deployment.DeploymentTrigger'
Triggers a build when artifacts from another project is deployed to servers via configuration management tools like Chef/Puppet/etc. For this feature to work, you must also install a plugin that's specific to the configuration management tool you are using, such as the puppet plugin.
For example, you can use this to run post-deployment smoke tests, or you can tickle your load balancer to shift traffic to newer servers.

This plugin injects the following variables:
- DEPLOYMENT_HOST - Host to which the artifact was deployed
- DEPLOYMENT_PATH - Path to which the artifact was deployed
- DEPLOYMENT_TIMESTAMP - Timestamp of the deployment
This feature critically depends on fingerprints to function properly.

Imagine you are deploying foo.rpm file with Puppet. Here is the sequence of events until this trigger fires:
1. You have job U that records the fingerprint of foo.rpm. This job is most typically a job that produces foo.rpm, but it could be any job so long as it records the fingerprint. For example, it might be a job that copies foo.rpm into your RPM repository.
2. You have job D that has a deployment trigger, which specifies U as the upstream.
3. Job U build #15 (or whatever) runs, a specific fingerprint (say b1946ac9) is recorded for this version of foo.rpm
4. At some point outside Jenkins, Puppet runs and chooses to lay down this foo.rpm. Your Puppet manifests do this by using specific resource types that Jenkins understands.
5. You configure Puppet to send the report back to Jenkins. Jenkins will analyze the report, pick up the details sent from the specific resource types, and learn that a file with fingerprint b1946ac9 was deployed.
6. Jenkins compares existing fingerprint records and find out that this foo.rpm came from U #15.
7. Jenkins notices that job D wants to run if an artifact from U is deployed, and this deployment satisfies that condition
8. Job D gets scheduled, with U #15 as the upstream.
- upstreamJob : String
  Specify the job whose artifacts you'd like to watch for triggering this job.
  The specified job must record fingerprints of the artifacts Chef/Puppet/etc deploys, when this trigger fires, the build to be started will see the corresponding build of the upstream job as the cause of the build, and receives all the parameters given to that upstream build.
- cond
  - $class: 'ThresholdCondition'
    env : String
    Chef/Puppet/etc defines a notion of "environment" as a means to group servers, so that you can have a set of servers in the 'testing' group and another set under the 'production' group. If this field is non-empty, this trigger will only count deployments to servers in the specific environment.
    
    threshold : int
    Number of servers the need to deploy the artifact before this trigger fires.

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.

User Handbook

Tutorials

Resources

pipelineTriggers

Special Characters