Index
aclaclEntryactualParameteraddCredentialapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobSteplicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

trigger

On this page
Back to index

Summary

The object responsible for triggering objects by some events.
projectName
Stringrequired
The name for the project that must be unique among all projects.
triggerName
Stringrequired
The name of the trigger.
accessTokenPublicId
Stringoptional
Public identifier of the access token.
actualParameters
Stringoptional
Actual parameters passed to the invoked object. (Alternate argument name actualParameter.)
applicationName
Stringoptional
The name of the application that owns the trigger and the process that should be run.
clearActualParameters
Stringoptional
Whether or not to clear actual parameters for this object.
clearPipelineParameters
Stringoptional
Whether or not to clear pipeline parameters for the trigger.
credentialName
Stringoptional
The name of the credential to use for impersonation.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
enabled
Stringoptional
True to enable the task.
environmentName
Stringoptional
The name of the environment used to determine where to run the process.
environmentProjectName
Stringoptional
Name for the project to which the environment or environment template belongs to.
environmentTemplateName
Stringoptional
The name of the environment template used to determine the environment where to run the process.
environmentTemplateProjectName
Stringoptional
Name for the project to which the environment template belongs to.
insertRollingDeployManualStep
Stringoptional
True to indicate a manual step to inject after each phase or batch.
newName
Stringoptional
The new name for an existing object that is being renamed.
pipelineName
Stringoptional
The name of the pipeline to run.
pipelineParameters
Stringoptional
Pipeline parameters used by a release schedule to override the default parameters configured in the release. (Alternate argument name pipelineParameter.)
pluginKey
Stringoptional
The key of the plugin to be used for trigger integration with 3rd-party system.
pluginParameters
Stringoptional
List of plugin parameters. (Alternate argument name pluginParameter.)
procedureName
Stringoptional
The name of the procedure that owns the process to run.
processName
Stringoptional
The name of the application process to invoke.
quietTimeMinutes
Stringoptional
Specify how long in minutes should pass since last trigger event before the trigger will run.
releaseName
Stringoptional
The name of the release to run.
rollingDeployEnabled
Stringoptional
Perform rolling deployment.
rollingDeployManualStepAssignees
Stringoptional
A list of assignees who receive the notification when rolling deploy iteration completes. (Alternate argument name rollingDeployManualStepAssignee.)
rollingDeployManualStepCondition
Stringoptional
Defines run condition on manual step created during rolling deployment. (Alternate argument name rollingDeployManualStepCondition.)
rollingDeployPhases
Stringoptional
One or more rolling deploy phases to be used for deployment. (Alternate argument name rollingDeployPhase.)
runDuplicates
Stringoptional
Specify whether a trigger should be run if the previously triggered process is still running.
scmSyncName
Stringoptional
The name of the scmSync trigger belong to.
serviceAccountName
Stringoptional
The name of the service account associated with a webhook trigger.
snapshotName
Stringoptional
The name of the snapshot to be used to invoke the application process.
stagesToRun
Stringoptional
One or more stages to run in a pipeline. (Alternate argument name stagesToRun.)
tierResourceCounts
Stringoptional
Resource count per resource template tier. (Alternate argument name tierResourceCount.)
triggerType
Stringoptional
A type of trigger.
webhookName
Stringoptional
Webhook name.
webhookSecret
Stringoptional
Webhook secret.
webhookSecretCredentialName
Stringoptional
Webhook secret credential name.
webhookSecretCredentialProjectName
Stringoptional
Webhook secret credential project name.

Usage

There are no usage examples available for trigger.