Breadcrumbs

Hex - Trigger Project

Overview

Immediately runs a Hex project. The project must already be set up and published within the Hex interface. This Blueprint will create and store the source ID used to `shipyard-artifacts/hex-blueprints/variables/runId.pickle`

Variables

Name

Reference

Type

Required

Default

Options

Description

Project ID

HEX_PROJECT_ID

Alphanumeric

✅

None

-

The Project Id can be acquired from the project URL itself or from within the project's variables section. See authorization page for more.

API Token

HEX_API_TOKEN

Password

✅

None

-

The API token is generated by Hex for a set amount of time. See authorization page for more

Wait For Completion

HEX_WAIT

Boolean

➖

TRUE

-

Enable if you would like the vessel to wait for the final status of the project run

YAML

Below is the YAML template

YAML

source:
  template: Hex - Trigger Project
  inputs:
    HEX_PROJECT_ID:
    HEX_API_TOKEN:
    HEX_WAIT: 'TRUE'
  type: TEMPLATE
guardrails:
  retry_count: 0
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 201
    - 226