Skip to content

FlowsInterfaceInitiateMessage

HTTP API schema

← HTTP API reference

Start a flow, optionally with parameters, a priority and a timeout.

FlowsInterfaceInitiateMessage fields

flowIdstringRequired

Unique identifier for the flow to initiate

minLength: 1

flowTypestringRequired

Type of flow to initiate

minLength: 1

parametersobjectRequired

Flow initiation parameters

prioritystring

Flow execution priority

Default: NORMAL

Allowed values: LOW, NORMAL, HIGH, URGENT.

timeoutinteger

Flow timeout in milliseconds

minimum: 1000

maximum: 86400000

metadataobject

Additional metadata for the flow initiation

View source specification ↗