Pass arguments

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to WAIT_FOR_VARIABLES.
variablesVariable[]The list of variables to set as parameters for the pipeline.
commentStringThe custom comment that will be visible upon passing the arguments.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS or VAR_NOT_CONTAINS.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Pass parameters",
"type": "WAIT_FOR_VARIABLES",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"comment": "Version should be like X.Y.Z",
"variables": [
{
"key": "version"
},
{
"key": "pass",
"encrypted":true
}
]
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/845",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/845/edit",
"id": 2,
"name": "Pass parameters",
"type": "WAIT_FOR_VARIABLES",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"comment": "Version should be like X.Y.Z",
"variables": [
{
"key": "version",
"value": "1.0"
},
{
"key": "pass",
"value": "secret_pass",
"encrypted":true
}
],
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}