Actions

Actions enable event-based pipeline execution, such as triggering a pipeline launch with a GitHub webhook whenever the pipeline repository is updated. Seqera Platform currently offers support for native GitHub webhooks and a general Tower webhook that can be invoked programmatically.

Path and query parameters

Name	Type	Location	Req/Opt	Description
workspaceId	integer	query	Optional	Workspace identifier
attributes	array	query	Optional	Additional attribute values to include in the response (labels, lastTrigger). Attributes not requested are returned as null.
name	string	query	Optional	Action name to validate
actionId	string	path	Required	Action identifier
max	integer	query	Optional	Maximum number of results to return. Default: 50.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
outcome	array	query	Optional	Filters triggers by outcome. One of PENDING, LAUNCHED, LAUNCH_FAILED, SUPPRESSED_CYCLE, or SUPPRESSED_RATE. Repeat the parameter or send a comma-separated list to match more than one outcome. If omitted, triggers with any outcome are returned.
firedAfterOrEqual	string	query	Optional	Returns only triggers fired at or after this date and time, in ISO 8601 format. Must not be later than firedBeforeOrEqual.
firedBeforeOrEqual	string	query	Optional	Returns only triggers fired at or before this date and time, in ISO 8601 format. Must not be earlier than firedAfterOrEqual.
triggerId	string	path	Required	Action trigger identifier.

Request body parameters

Name	Type	Req/Opt	Description
CreateAction			Create action
name	string	Optional	Unique action name. Must be unique within the user or workspace context.
source	string	Optional	Action event source. One of github (GitHub webhook), tower (launch hook called through the API), bucket (cloud storage bucket event), cron (schedule), or pipeline_status (a run of a watched pipeline reaches a given state).
launch	object	Optional	Settings for the run the action starts. Required when responseType is pipeline. Must be omitted when responseType is agent.
launch.id	string	Optional	Launch configuration identifier.
launch.computeEnvId	string	Optional	Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted.
launch.runName	string	Optional	Custom run name for the workflow execution.
launch.pipeline	string	Optional	Pipeline repository URL (e.g., https://github.com/nextflow-io/hello).
launch.workDir	string	Optional	Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted.
launch.revision	string	Optional	Git revision, branch, or tag to use.
launch.sessionId	string	Optional	Nextflow session identifier for resuming failed runs.
launch.configProfiles	array	Optional	Array of Nextflow configuration profile names to apply.
launch.userSecrets	array	Optional	Array of user secrets to make available to the pipeline.
launch.workspaceSecrets	array	Optional	Array of workspace secrets to make available to the pipeline.
launch.configText	string	Optional	Nextflow configuration as text (overrides config files).
launch.towerConfig	string	Optional	Platform-specific configuration options.
launch.paramsText	string	Optional	Pipeline parameters in JSON or YAML format.
launch.preRunScript	string	Optional	Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
launch.postRunScript	string	Optional	Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
launch.mainScript	string	Optional	Alternative main script filename. Default: main.nf.
launch.entryName	string	Optional	Workflow entry point name when using Nextflow DSL2.
launch.schemaName	string	Optional	Name of the pipeline schema to use.
launch.resume	boolean	Optional	Enable resume to restart workflow execution from the last successful process. See Resume a workflow run.
launch.pullLatest	boolean	Optional	Pull the latest version of the pipeline from the repository.
launch.stubRun	boolean	Optional	Execute a stub run for testing (processes return dummy results).
launch.optimizationId	string	Optional	Optimization configuration identifier. See Pipeline resource optimization.
launch.optimizationTargets	string	Optional	Comma-separated list of optimization targets. See Pipeline resource optimization.
launch.labelIds	array	Optional	Array of label IDs to assign to each pipeline run.
launch.headJobCpus	integer	Optional	Number of CPUs allocated for the Nextflow head job.
launch.headJobMemoryMb	integer	Optional	Memory allocation for the Nextflow head job in megabytes.
launch.launchContainer	string	Optional	Container image to use for the Nextflow launcher.
launch.dateCreated	string	Optional	Timestamp when the launch configuration was created.
launch.outputDir	string	Optional	Output directory for the run, passed to Nextflow as -output-dir. Requires Nextflow 24.10.0 or later and a pipeline that uses workflow outputs. Can be null.
launch.syntaxParser	string	Optional	Nextflow syntax parser version used for the run. One of v1 or v2. Default: v1.
launch.fusionVersion	string	Optional	Fusion version to run the workflow with. Must exist in the system catalog and be compatible with the deployed services. Applies only when the compute environment enables Wave and Fusion v2 and overrideNextflowFusionVersion is enabled. When null or empty, inherits the source pipeline or run, then the compute environment, then the catalog default.
launch.nextflowVersion	string	Optional	Nextflow release version to run the workflow with. Must exist in the system catalog and meet the minimum version configured for the compute environment type. Can be null.
launch.commitId	string	Optional	Git commit ID to launch.
launch.pipelineSchemaId	integer	Optional	Pipeline schema identifier to apply to the launch.
launch.fusionSnapshots	boolean	Optional	If true, enables Fusion snapshots for the workflow. Can only be enabled when the compute environment runs Wave, Fusion v2, and Spot instances. When null, inherits the source pipeline or run, then the compute environment setting.
launch.overrideNextflowFusionVersion	boolean	Optional	If true, runs the workflow with fusionVersion instead of the Fusion version provided by the Nextflow launcher container. Applies only when the compute environment enables Wave and Fusion v2. When null, inherits the source pipeline or run, then the compute environment setting.
bucket	object	Optional	Bucket trigger configuration: the data-link and the marker file to watch. Required when source is bucket. Ignored for other sources.
bucket.dataLinkId	string	Optional	Data-link identifier that provides the bucket location and credentials.
bucket.events	array	Optional	Array of bucket event types that trigger the action, for example object:created.
bucket.markerFile	string	Optional	Marker file name that signals batch completion and triggers the pending bucket event batch to be flushed.
cron	object	Optional	Cron trigger configuration: the schedule and its timezone. Required when source is cron. Ignored for other sources.
cron.expression	string	Optional	Standard 5-field cron expression defining the schedule pattern (e.g., 0 2 * * *). Mutually exclusive with preset.
cron.preset	string	Optional	Preset schedule identifier (e.g., hourly or daily_midnight). Mutually exclusive with expression. Can be null.
cron.timezone	string	Optional	Timezone for schedule evaluation in IANA format (e.g., Europe/London). Default: UTC.
agent	object	Optional	Agent outcome configuration. Required when responseType is agent, which in turn requires source to be bucket, cron, or pipeline_status. Must be omitted when responseType is pipeline.
agent.agentConfigId	string	Required	Identifier of an existing workspace agent to run.
labelIds	array	Optional	Array of label identifiers to attach to the action. Send only when the action has no launch configuration. Requests that also send launch.labelIds are rejected. Can be null.
pipeline	object	Optional	Pipeline outcome configuration. Optional. Links the action to an existing Launchpad pipeline and version; the run uses the settings in launch and is recorded as a run of the linked pipeline. Allowed when responseType is pipeline, for any source. Must be omitted when responseType is agent. On a pipeline_status action, set the pipeline to watch in pipelineStatus.
pipeline.targetPipelineId	integer	Optional	Pipeline identifier of the Launchpad pipeline to launch. Required when creating an action whose responseType is pipeline. Can be null.
pipeline.targetPipelineVersionId	string	Optional	Pipeline version identifier that the launch settings come from. If omitted, the current version is kept, or the pipeline default version is used when creating the action or moving it to another pipeline. Can be null.
pipelineStatus	object	Optional	Pipeline status trigger configuration: the pipeline to watch and the run state that fires the action. Required when source is pipeline_status. Ignored for other sources. The run the action starts is set in launch.
pipelineStatus.pipelineId	integer	Optional	Pipeline identifier of the Launchpad pipeline to watch. Required when creating the action. Can be null.
pipelineStatus.runStatus	string	Optional	Run state that triggers the action. One of SUCCEEDED, FAILED, or CANCELLED. Required when creating the action. Can be null.
responseType	string	Optional	What the action does when it is triggered. One of pipeline or agent. Cannot be changed after the action is created. Default: pipeline.
ResolveCronExpression			Resolve cron expression
text	string	Required	Free-text schedule description (e.g., Every 10 minutes) or cron expression to resolve. Maximum 200 characters. A valid cron expression is returned unchanged.
UpdateAction			Update action
name	string	Optional	Updated action name. Must remain unique within the user or workspace context.
launch	object	Optional	Settings for the run the action starts. Required on an action whose responseType is pipeline, because the update overwrites every stored launch setting. On an agent action, the request returns 400.
launch.id	string	Optional	Launch configuration identifier.
launch.computeEnvId	string	Optional	Compute environment identifier where the pipeline will run. Defaults to workspace primary compute environment if omitted.
launch.runName	string	Optional	Custom run name for the workflow execution.
launch.pipeline	string	Optional	Pipeline repository URL (e.g., https://github.com/nextflow-io/hello).
launch.workDir	string	Optional	Work directory path where workflow intermediate files are stored. Defaults to compute environment work directory if omitted.
launch.revision	string	Optional	Git revision, branch, or tag to use.
launch.sessionId	string	Optional	Nextflow session identifier for resuming failed runs.
launch.configProfiles	array	Optional	Array of Nextflow configuration profile names to apply.
launch.userSecrets	array	Optional	Array of user secrets to make available to the pipeline.
launch.workspaceSecrets	array	Optional	Array of workspace secrets to make available to the pipeline.
launch.configText	string	Optional	Nextflow configuration as text (overrides config files).
launch.towerConfig	string	Optional	Platform-specific configuration options.
launch.paramsText	string	Optional	Pipeline parameters in JSON or YAML format.
launch.preRunScript	string	Optional	Add a script that executes in the nf-launch script prior to invoking Nextflow processes. See Pre and post-run scripts.
launch.postRunScript	string	Optional	Add a script that executes after all Nextflow processes have completed. See Pre and post-run scripts.
launch.mainScript	string	Optional	Alternative main script filename. Default: main.nf.
launch.entryName	string	Optional	Workflow entry point name when using Nextflow DSL2.
launch.schemaName	string	Optional	Name of the pipeline schema to use.
launch.resume	boolean	Optional	Enable resume to restart workflow execution from the last successful process. See Resume a workflow run.
launch.pullLatest	boolean	Optional	Pull the latest version of the pipeline from the repository.
launch.stubRun	boolean	Optional	Execute a stub run for testing (processes return dummy results).
launch.optimizationId	string	Optional	Optimization configuration identifier. See Pipeline resource optimization.
launch.optimizationTargets	string	Optional	Comma-separated list of optimization targets. See Pipeline resource optimization.
launch.labelIds	array	Optional	Array of label IDs to assign to each pipeline run.
launch.headJobCpus	integer	Optional	Number of CPUs allocated for the Nextflow head job.
launch.headJobMemoryMb	integer	Optional	Memory allocation for the Nextflow head job in megabytes.
launch.launchContainer	string	Optional	Container image to use for the Nextflow launcher.
launch.dateCreated	string	Optional	Timestamp when the launch configuration was created.
launch.outputDir	string	Optional	Output directory for the run, passed to Nextflow as -output-dir. Requires Nextflow 24.10.0 or later and a pipeline that uses workflow outputs. Can be null.
launch.syntaxParser	string	Optional	Nextflow syntax parser version used for the run. One of v1 or v2. Default: v1.
launch.fusionVersion	string	Optional	Fusion version to run the workflow with. Must exist in the system catalog and be compatible with the deployed services. Applies only when the compute environment enables Wave and Fusion v2 and overrideNextflowFusionVersion is enabled. When null or empty, inherits the source pipeline or run, then the compute environment, then the catalog default.
launch.nextflowVersion	string	Optional	Nextflow release version to run the workflow with. Must exist in the system catalog and meet the minimum version configured for the compute environment type. Can be null.
launch.commitId	string	Optional	Git commit ID to launch.
launch.pipelineSchemaId	integer	Optional	Pipeline schema identifier to apply to the launch.
launch.fusionSnapshots	boolean	Optional	If true, enables Fusion snapshots for the workflow. Can only be enabled when the compute environment runs Wave, Fusion v2, and Spot instances. When null, inherits the source pipeline or run, then the compute environment setting.
launch.overrideNextflowFusionVersion	boolean	Optional	If true, runs the workflow with fusionVersion instead of the Fusion version provided by the Nextflow launcher container. Applies only when the compute environment enables Wave and Fusion v2. When null, inherits the source pipeline or run, then the compute environment setting.
bucket	object	Optional	Bucket trigger updates: the marker file and the events. The data-link cannot change. Only allowed on a bucket action; on other actions, the request returns 400.
bucket.dataLinkId	string	Optional	Data-link identifier that provides the bucket location and credentials.
bucket.events	array	Optional	Array of bucket event types that trigger the action, for example object:created.
bucket.markerFile	string	Optional	Marker file name that signals batch completion and triggers the pending bucket event batch to be flushed.
cron	object	Optional	Cron trigger updates: the schedule and its timezone. An omitted field keeps its stored value, but setting expression clears a stored preset. Only allowed on a cron action; on other actions, the request returns 400.
cron.expression	string	Optional	Standard 5-field cron expression defining the schedule pattern (e.g., 0 2 * * *). Mutually exclusive with preset.
cron.preset	string	Optional	Preset schedule identifier (e.g., hourly or daily_midnight). Mutually exclusive with expression. Can be null.
cron.timezone	string	Optional	Timezone for schedule evaluation in IANA format (e.g., Europe/London). Default: UTC.
labelIds	array	Optional	Array of label identifiers of the action, as a complete set. Omit to leave labels unchanged; send an empty array to remove all labels. Send only when the action has no launch configuration. Requests that also send launch.labelIds are rejected. Can be null.
pipeline	object	Optional	Pipeline outcome updates. Changes the Launchpad pipeline and version the action is linked to; the run uses the settings in launch. On a pipeline_status action, set the pipeline to watch in pipelineStatus. Only allowed on an action whose responseType is pipeline; on an agent action, the request returns 400.
pipeline.targetPipelineId	integer	Optional	Pipeline identifier of the Launchpad pipeline to launch. Required when creating an action whose responseType is pipeline. Can be null.
pipeline.targetPipelineVersionId	string	Optional	Pipeline version identifier that the launch settings come from. If omitted, the current version is kept, or the pipeline default version is used when creating the action or moving it to another pipeline. Can be null.
pipelineStatus	object	Optional	Pipeline status trigger updates: the pipeline to watch and the run state that fires the action. Only allowed on a pipeline_status action; on other actions, the request returns 400. The run the action starts is set in launch.
pipelineStatus.pipelineId	integer	Optional	Pipeline identifier of the Launchpad pipeline to watch. Required when creating the action. Can be null.
pipelineStatus.runStatus	string	Optional	Run state that triggers the action. One of SUCCEEDED, FAILED, or CANCELLED. Required when creating the action. Can be null.
LaunchAction			Trigger Tower Launch action
params	object	Optional	Pipeline parameters to apply to the launch, as key-value pairs.
PauseAction			Pause or resume action