HEherondata
Workflows

Start a workflow by name for an end user

Start a workflow by name for an end user

post/api/workflow/start_by_name

Request

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

Request body

end_user_heron_idstring required
trigger_idstring nullable

Trigger node ID on the resolved workflow version.

trigger_payloadobject

JSON payload validated against the trigger node schema when present.

workflow_namestring required
workflow_parametersobject

Response

Workflow started successfully

actionstring
statusstring
workflow_execution_idstring
workflow_idstring

Changes

No recorded changes to this operation across all 2 revisions of this API.