Skip to main content
POST
Start a workflow for an end user

Authorizations

x-api-key
string
header
required

Body

application/json
end_user_heron_id
string
required
silent_run
boolean
default:false
trigger_id
string | null

Trigger node ID on the resolved workflow version.

trigger_payload
object

JSON payload validated against the trigger node schema when present.

workflow_heron_id
string | null
workflow_parameters
object
workflow_version_number
integer | null

Response

Workflow started successfully

action
string
read-only
status
string
read-only
workflow_execution_id
string
read-only
workflow_id
string
read-only