setupWebhook

Back to index

Summary

Run the specified setupWebhook, returns RunProcedureResult.

In addition, it passes the webhookSecret and triggerId as parameters from those specified in triggerName.

  • One of following arguments must be specified: [pipelineName], [releaseName], [catalogName, catalogItemName], [applicationName], or [procedureName]

  • The actualParameters argument must match the formal parameters of the triggered object.

actualParameter
Arrayoptional
Parameters passed to the invoked procedure.
applicationName
Stringoptional
The name of the application.
credential
Arrayoptional
Credentials to be used in the job.
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.

Usage

Perl

$cmdr->setupWebhook( # optionals );

ectool

ectool setupWebhook \ # optionals

Examples

Perl

Pipeline example

# for pipeline $cmdr->setupWebhook( {projectName => "qe proj", triggerName => "qe trigger 1", pipelineName => "qe pipeline name", actualParameter => [{actualParameterName => "ec_action", value =>'create'}, {actualParameterName => "credentialsType", value =>'configuration'}, {actualParameterName => "configuration", value =>'github config'}, {actualParameterName => "insecureSsl", value =>'true'}] });

Procedure example

$cmdr->setupWebhook( {projectName => "qe proj", triggerName => "qe trigger 1", procedureName => "qe procedure name", actualParameter => [{actualParameterName => "ec_action", value =>'create'}, {actualParameterName => "credentialsType", value =>'configuration'}, {actualParameterName => "configuration", value =>'github config'}, {actualParameterName => "insecureSsl", value =>'true'}] });

ectool

Pipeline example

ectool setupWebhook --projectName "qe proj" --triggerName "qe trigger name" --pipelineName "qe pipeline name" --actualParameter "ec_action=create" "credentialsType=configuration" "configuration=github config" "insecureSsl=true"

Procedure example

ectool setupWebhook --projectName "qe proj" --triggerName "qe trigger name" --procedureName "qe pipeline name" --actualParameter "ec_action=create" "credentialsType=configuration" "configuration=github config" "insecureSsl=true"