Pass arguments

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

url PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to WAIT_FOR_VARIABLES.
commentoptional string
The custom comment that will be visible upon passing the arguments.
permissionsoptional PipelinePermissions
Define to set permissions for the action.
othersoptional string
AccessLevel for the group Others. Can be one of DENIED, ALLOWED. Default setting is ALLOWED.
usersoptional UserPermission[]
The list of users who will be granted a permission other than the Others group.
idrequired integer
The user ID.
access_levelrequired string
AccessLevel for a user. Can be one of DENIED, ALLOWED. Default setting is ALLOWED.
groupsoptional GroupPermission[]
The group who will be granted a permission other than the Others group.
idrequired integer
The group ID.
access_levelrequired string
AccessLevel for a group. Can be one of DENIED, ALLOWED. Default setting is ALLOWED.

Last modified on Sep 23, 2024

{
  "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
    }
  ]
}
{
  "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"
  }
}