HEherondata
Workflows

Start a workflow for an end user

Changed on

Start a workflow by heron_id for an end user, or start the default workflow if no workflow_heron_id provided

post/api/workflow/start

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/workflow/start
  • Auth
    API key in header x-api-key

Request body

end_user_heron_idstring required
silent_runboolean
trigger_idstring nullable

Trigger node ID on the resolved workflow version.

trigger_payloadobject

JSON payload validated against the trigger node schema when present.

workflow_heron_idstring nullable
workflow_parametersobject
workflow_version_numberinteger nullable

Response

Workflow started successfully

actionstring
statusstring
workflow_execution_idstring
workflow_idstring

Changes