POST
/
api
/
workflow
/
start
Start a workflow for an end user
curl --request POST \
  --url https://app.herondata.io/api/workflow/start \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "end_user_heron_id": "<string>",
  "workflow_heron_id": null,
  "workflow_parameters": {}
}'
{
  "action": "<string>",
  "status": "<string>",
  "workflow_execution_id": "<string>",
  "workflow_id": "<string>"
}

Authorizations

x-api-key
string
header
required

Body

application/json
end_user_heron_id
string
required
workflow_heron_id
string | null
workflow_parameters
object

Response

Workflow started successfully

action
string
status
string
workflow_execution_id
string
workflow_id
string