Start workflow by slug
Initiates a workflow run based on its slug. Accepts JSON or multipart/form-data for input.
Headers
Controls how the request body is parsed for start data. 'standard' (default): expects start data nested under a 'startData' key, e.g. { "startData": { "foo": "bar" } }. 'top-level': treats the entire request body as start data, e.g. { "foo": "bar" }. This header is experimental and may change in the future.
standard, top-level Path Parameters
The slug of the workflow definition to start.
Query Parameters
Whether to wait for the first task before responding. Set to false to return as soon as the workflow run is queued.
true, false Body
The workflow input data. Format depends on X-Sample-Start-Data-Parse-Method header: If 'standard' (default), wrap your data in a 'startData' key: { "startData": { ... } }. If 'top-level', provide your data directly at the root level: { ... }. For multipart/form-data requests, include fields and files directly in the form data.
The workflow input data. Format depends on X-Sample-Start-Data-Parse-Method header: If 'standard' (default), wrap your data in a 'startData' key: { "startData": { ... } }. If 'top-level', provide your data directly at the root level: { ... }. For multipart/form-data requests, include fields and files directly in the form data.
Response
Workflow initiated successfully.