PRprocess
Comments

Create a comment

Creates a comment on a task within a workflow run.

post/comments

Request

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

Request body

workflowRunIdstring required

The ID of the Workflow Run

taskIdstring required

The ID of the Task

textstring required

Example request

{
  "workflowRunId": "jMSFMeYlJ9wBoZxtgCt8_g",
  "taskId": "jMSFMeYlJ9wBoZxtgCt8_g"
}

Response

Example response

{
  "data": {
    "id": "gde-CKSrS14BoZxtgDh0Iw",
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "workflowRunId": "gde-CKSrS14BoZxtgDh0Iw",
    "taskId": "gde-CKSrS14BoZxtgDh0Iw",
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "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.