Pass arguments
Learn more about:
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to WAIT_FOR_VARIABLES . |
comment | String | The custom comment that will be visible upon passing the arguments. |
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",
"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",
"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",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}
Last modified on November 16, 2022