Skip to main content
POST
/
api
/
v2
/
workflows
/
{workflowSlug}
/
start
Python
from samplehc import SampleHealthcare

client = SampleHealthcare(
    api_key="My API Key",
)
response = client.v2.workflows.start(
    workflow_slug="workflowSlug",
)
print(response.next_task_id)
{
  "workflowRunId": "<string>",
  "nextTaskId": "<string>"
}

Headers

X-Sample-Start-Data-Parse-Method
enum<string>

The method for parsing start data. This is experimental, and may change in the future.

Available options:
standard,
top-level

Path Parameters

workflowSlug
string
required

The slug of the workflow definition to start.

Body

application/json · any

The body is of type any.

Response

Workflow initiated successfully.

workflowRunId
string
required

The ID of the newly started workflow run. This can be used to check its status or cancel the run.

nextTaskId
string | null
required

The ID of the first task in the workflow run, or null if the workflow completes synchronously or has no starting task.

I