Add action
- POST
- /workspaces
- /:domain
- /projects
- /:project_name
- /pipelines
- /:pipeline_id
- /actions
Adds a new action to the specified pipeline.
Hint
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.
Request
REQUIRED SCOPES
WORKSPACE, EXECUTION_MANAGE
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 ID of the action.typerequired string
The type of the action.trigger_conditionsoptional TriggerCondition[]
The list of trigger conditions to meet so that the action can be triggered.trigger_conditionrequired string
Defines when the action should be run. Can be one of 'ON_CHANGE', 'ON_CHANGE_AT_PATH', 'VAR_IS', 'VAR_IS_NOT', 'VAR_CONTAINS', 'VAR_NOT_CONTAINS', 'VAR_LESS_THAN', 'VAR_LESS_THAN_OR_EQUAL', 'VAR_GREATER_THAN', 'VAR_GREATER_THAN_OR_EQUAL', 'DAY', 'HOUR', 'TRIGGERING_USER_IS', 'TRIGGERING_USER_IS_NOT', 'TRIGGERING_USER_IS_IN_GROUP', 'TRIGGERING_USER_IS_NOT_IN_GROUP', 'SUCCESS_PIPELINE', 'ACTION_STATUS_IS' or 'ACTION_STATUS_IS_NOT' (last two can only be set in an action).trigger_condition_pathsoptional string[]
Required when 'trigger_condition' is set to 'ON_CHANGE_AT_PATH'.trigger_variable_keyoptional string
Required when 'trigger_condition' is set to 'VAR_IS', 'VAR_IS_NOT' or 'VAR_CONTAINS' or 'VAR_NOT_CONTAINS', 'VAR_LESS_THAN', 'VAR_LESS_THAN_OR_EQUAL', 'VAR_GREATER_THAN', 'VAR_GREATER_THAN_OR_EQUAL'. Defines the name of the desired variable.trigger_variable_valueoptional string
Required when 'trigger_condition' is set to 'VAR_IS', 'VAR_IS_NOT' or 'VAR_CONTAINS' or 'VAR_NOT_CONTAINS', 'VAR_LESS_THAN', 'VAR_LESS_THAN_OR_EQUAL', 'VAR_GREATER_THAN', 'VAR_GREATER_THAN_OR_EQUAL'. Defines the value of the desired variable which will be compared with its current value.trigger_hoursoptional integer[]
Available when 'trigger_condition' is set to 'HOUR'. Defines the time – by default running from 1 to 24.trigger_daysoptional integer[]
Available when 'trigger_condition' is set to 'DAY'. Defines the days running from 1 to 7 where 1 is for Monday.zone_idoptional string
Available when 'trigger_condition' is set to 'DAY' or 'HOUR'. Defines the timezone (by default it is UTC) and takes values from here.trigger_project_nameoptional string
Required when 'trigger_condition' is set to 'SUCCESS_PIPELINE'. Defines the name of the project in which the 'trigger_pipeline_name' is.trigger_pipeline_nameoptional string
Required when 'trigger_condition' is set to 'SUCCESS_PIPELINE'. Defines the name of the pipeline.trigger_action_nameoptional string
Required when 'trigger_condition' is set to 'ACTION_STATUS_IS' or 'ACTION_STATUS_IS_NOT'. Defines the name of the action.trigger_statusoptional string
Required when 'trigger_condition' is set to 'ACTION_STATUS_IS' or 'ACTION_STATUS_IS_NOT'. Defines the status that the action should or shouldn't have. Can be one of 'SUCCESSFUL', 'SKIPPED', 'SUPRESSED' or 'FAILED'.trigger_useroptional string
Required when 'trigger_condition' is set to 'TRIGGERING_USER_IS' or 'TRIGGERING_USER_IS_NOT'. Defines the email address of the user.trigger_groupoptional string
Required when 'trigger_condition' is set to 'TRIGGERING_USER_IS_IN_GROUP' or 'TRIGGERING_USER_IS_NOT_IN_GROUP'. Defines the name of the group.variablesoptional Variable[]
The list of variables you can use the action.after_action_idoptional integer
The numerical ID of the action, after which this action should be added.timeoutoptional integer
The timeout in seconds.disabledoptional boolean
When set to true the action is disabled. By default it is set to false.run_next_paralleloptional boolean
When set to true, the subsequent action defined in the pipeline will run in parallel to the current action.run_only_on_first_failureoptional boolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.ignore_errorsoptional boolean
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_intervaloptional integer
Delay time between auto retries in seconds.retry_countoptional integer
Number of retries if the action fails.trigger_timeoptional string
Specifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE, ON_BACK_TO_SUCCESS, ON_WARNING or ON_WAIT_FOR_APPROVE. The default value is ON_EVERY_EXECUTION.Last modified on Sep 23, 2024