PRprocess
Workflow Runs

Create a workflow run

Creates a new workflow run for the specified workflow.

post/workflow-runs

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/workflow-runs
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

workflowIdstring required

The ID of the Workflow

namestring

The name of the new Workflow Run

dueDatestring date-time

The due date of the new Workflow Run (Optional)

sharedboolean

Example request

{
  "workflowId": "oKVLLIll2DMBoZxtf2RzLg"
}

Response

idstring required

The ID of the Workflow Run

Example response

{
  "id": "sVs_IxY5Ps0BoZxtgV93xg",
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

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