runTrigger

Back to index

Summary

Run the specified trigger, returns the flowRuntimeId.

The following parameters are valid combinations for each trigger type:

Application: [projectName,applicationName, triggerName]
Catalog item: [projectName, catalogName, catalogItemName, triggerName]
Pipeline: [projectName, pipelineName, triggerName]
Release: [projectName, releaseName, triggerName]
Procedure: [projectName, procedureName, triggerName]

applicationName

Stringoptional

The name of the application.

parsedWebhookData

Stringoptional

JSON with parsed webhook data to be set on a pipeline/release/procedure run.

path

Stringoptional

Property path string.

pipelineName

Stringoptional

The name of the pipeline.

procedureName

Stringoptional

Name for the procedure; must be unique within the project.

projectName

Stringoptional

The name for the project that must be unique among all projects.

releaseName

Stringoptional

The name of the release.

scmSyncName

Stringoptional

The name of the scm sync.

triggerName

Stringoptional

The name of the trigger.

webhookData

Stringoptional

The webhook data to be set on the pipeline/release/procedure run.

webhookHeaders

Stringoptional

The webhook headers in JSON format to be set on the pipeline/release/procedure run.

Usage

Perl

$cmdr->runTrigger(
  # optionals
);▼

ectool

ectool runTrigger \
  # optionals▼

Examples

Perl

# for pipeline
$cmdr->runTrigger(
     {projectName => "qe proj",
      pipelineName => "qe pipeline name",
      triggerName => "qe trigger 1",
      webhookData => "test",
      webhookHeaders => "Test",
      parsedWebhookData => "\"{\"branch\": \"master\"}\""});
# for procedure
$cmdr->runTrigger(
     {projectName => "qe proj",
      procedureName => "qe procedure name",
      triggerName => "qe trigger 1",
      webhookData => "test",
      webhookHeaders => "Test",
      parsedWebhookData => "\"{\"branch\": \"master\"}\""});▼

ectool

ectool runTrigger --projectName "qe proj"
--pipelineName "qe pipeline name"
--triggerName "qe trigger 1"
--webhookData "test"
--webhookHeaders "test"
--parsedWebhookData ""{\"branch\":\"master\"}" "▼