GitHub CLI

View as Markdown

POST
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Creates a new GitHub CLI action in the pipeline

Request

REQUIRED SCOPES

EXECUTION_MANAGE

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

project_namerequiredstring

The human-readable ID of the project

Example: "my-project"

pipeline_idrequiredinteger

The ID of the pipeline

Example: 123

POST PARAMETERS

typerequiredstring enum

The type of the action

Allowed enum:

GIT_HUB_CLI

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

after_action_idinteger

The numerical ID of the action, after which this action should be added

namerequiredstring

The name of the action

trigger_timestring enum

Specifies when the action should be executed

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

trigger_conditionsTriggerConditionView[]

The list of trigger conditions to meet so that the action can be triggered

run_nextstring enum

Defines whether the action should run in parallel with the next one

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE

variablesEnvironmentVariableView[]

The list of variables you can use the action

disabledboolean

When set to true the action is disabled. By default it is set to false

timeoutinteger

The timeout in seconds

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions

retry_countinteger

Number of retries if the action fails

retry_intervalinteger

Delay time between auto retries in seconds

loopstring[]

The list of commands that will be executed in a loop

current_revisionstring

The git revision of the last successful run of the action

permissionsPermissionsView

Access permissions configuration

shellstring enum

The name of the shell that will be used to execute commands

Allowed enum:

SH,

BASH,

POWERSHELL

setup_commandsstring[]

The command that will be executed only on the first run

execute_commandsrequiredstring[]

The commands that will be executed

execute_every_commandboolean

If set to true all commands will be executed regardless of the result of the previous command

integrationrequiredGitHubIntegrationRef

GitHub integration (GIT_HUB|GIT_HUB_ENTERPRISE)

Response

RESPONSE BODY

typestring enum

The type of the action

Allowed enum:

GIT_HUB_CLI

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

idinteger

The ID of the action

namestring

The name of the action

current_revisionstring

The git revision of the last successful run of the action

trigger_timestring enum

Specifies when the action should be executed

Allowed enum:

ON_EVERY_EXECUTION,

ON_SUCCESS,

ON_FAILURE,

ON_BACK_TO_SUCCESS,

ON_WARNING,

ON_WAIT_FOR_APPROVE,

ON_TERMINATE

trigger_conditionsTriggerConditionView[]

The list of trigger conditions to meet so that the action can be triggered

run_nextstring enum

Defines whether the action should run in parallel with the next one

Allowed enum:

WAIT_ON_SUCCESS,

IN_SOFT_PARALLEL,

IN_HARD_PARALLEL

run_only_on_first_failureboolean

Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE

variablesEnvironmentVariableView[]

The list of variables you can use the action

disabledboolean

When set to true the action is disabled. By default it is set to false

timeoutinteger

The timeout in seconds

ignore_errorsboolean

If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions

retry_countinteger

Number of retries if the action fails

retry_intervalinteger

Delay time between auto retries in seconds

last_execution_statusstring enum

The status of the last run of the action

Allowed enum:

INPROGRESS,

ENQUEUED,

TERMINATED,

SUCCESSFUL,

FAILED,

INITIAL,

NOT_EXECUTED,

SKIPPED,

TERMINATING,

WAITING_FOR_APPLY,

WAITING_FOR_VARIABLES,

WAITING_FOR_SETTABLE_VARIABLES,

WAITING_FOR_VT_SESSION

pipelineShortPipelineView

Short representation of a pipeline

permissionsPermissionsView

Access permissions configuration

loopstring[]

The list of commands that will be executed in a loop

shellstring enum

The name of the shell that will be used to execute commands

Allowed enum:

SH,

BASH,

POWERSHELL

setup_commandsstring[]

The command that will be executed only on the first run

execute_commandsstring[]

The commands that will be executed

execute_every_commandboolean

If set to true all commands will be executed regardless of the result of the previous command

integrationIntegrationIdentifierView

The integration used by the action

Last modified on Mar 18, 2026

Edit action Get action

Request example


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Run GitHub CLI command",
  "type": "GIT_HUB_CLI",
  "trigger_time": "ON_EVERY_EXECUTION",
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "gh repo list"
  ],
  "shell": "BASH",
  "variables": [
    {
      "key": "command",
      "value": "list-functions"
    }
  ],
  "integration": {
    "identifier": "github"
  }
}'

STATUS
200 OK