Add action

Adds a new action to the specified pipeline.

Required scopes: WORKSPACE, EXECUTION_MANAGE

Resource URL

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

URL Parameters

NameTypeDescription
domain
Required
StringThe workspace domain.
pipeline_id
Required
IntegerThe numerical ID of the desired pipeline.
project_name
Required
StringThe name ID of the project.

Actions schema

Properties

NameTypeDescription
name
Required
StringThe ID of the action.
type
Required
StringThe type of the action.
trigger_conditionsTriggerCondition[]The list of trigger conditions to meet so that the action can be triggered.
variablesVariable[]The list of variables you can use the action.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
timeoutIntegerThe timeout in seconds.
disabledBooleanWhen set to true the action is disabled. By default it is set to false.
run_next_parallelBooleanWhen set to true, the subsequent action defined in the pipeline will run in parallel to the current action.
run_only_on_first_failureBooleanDefines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
ignore_errorsBooleanIf 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_intervalIntegerDelay time between auto retries in seconds.
retry_countIntegerNumber of retries if the action fails.
trigger_timeStringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTIONON_FAILUREON_BACK_TO_SUCCESS, ON_WARNING or ON_WAIT_FOR_APPROVE. The default value is ON_EVERY_EXECUTION.
On top of these properties every action has a set of properties unique to its type. You can read how to define each type in separate articles below.

Last modified on July 12, 2023

Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat or contact support

Get Started

Sign up for free and deploy your project in less than 10 minutes.