Breadcrumbs

Portable - Trigger Flow

Overview

Use this blueprint to trigger a Portable flow to run. It is recommended to leave the `Wait for Completion` option set to `TRUE` so that the vessel exits upon completion of the flow in Portable. If the option is set to `FALSE` the vessel will exit upon successfully triggering the flow.

Variables

Name

Reference

Type

Required

Default

Options

Description

API Token

PORTABLE_API_TOKEN

Password

-

-

The API token generated in Portable

Flow ID

PORTABLE_FLOW_ID

Alphanumeric

-

-

The ID of the flow to run

Wait for Completion

PORTABLE_WAIT

Boolean

TRUE

-

Whether to wait for the flow to complete. If TRUE, Workflows will wait for completion before exiting

YAML

Below is the YAML template

YAML

source:
  template: Portable - Trigger Flow
  inputs:
    PORTABLE_API_TOKEN:
    PORTABLE_FLOW_ID:
    PORTABLE_WAIT: 'TRUE'
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 200
    - 201
    - 203
    - 210
    - 211
    - 214
    - 249