Skip to main content

Workflows: trigger from outside

A workflow can be started by your own software. On a governed deployment every active workflow is available over a REST API: another application lists workflows and their parameters, starts a run with the parameters you would type into Run with parameters, polls it, downloads its outputs and can cancel it. Keys are created by an Organisation administrator in the Organisations console; Studio has no screen for them.

Steps​

  1. Check for the governed chip at the top of Studio (Working in a governed deployment) and that the workflow has an active version.
  2. Read Programmatic access: overview, then Run a workflow from your system for the calls in order, with examples.

What you should see​

A run started this way appears in the runs list and on the run page like any other, with the Trigger chip API or API key plus the key's id, and the caller's reference in the header. Approvals it asks for appear in the Inbox for everyone assigned (Run, schedule, approve).

Notes​

  • Governed deployments only; a key can start only workflows with an active version.
  • A run that reads from an AWS connector is refused with 409 workflow_not_ready until the connector has a recorded passing test; the one at creation counts (AWS connector).
  • Errors returned to the caller: Limits, errors and codes.