Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Workflow Widgets

Create a widget

Creates a widget on a task within a draft workflow revision. Text content can include merge tag variables (e.g. {{workflow.name}}). Use the listWorkflowRevisionVariables endpoint to discover available variables.

post/workflows/{workflowId}/revisions/{revisionId}/tasks/{taskId}/widgets

Path parameters

workflowIdstring required

The ID of the Workflow

revisionIdstring required

The ID of the Revision

taskIdstring required

The ID of the Task

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "type": "FormField"
}

Response

Example response

{
  "data": {
    "id": "hUI7y6YGKMuZBMDLJc5Kdw",
    "taskId": "hUI7y6YGKMuZBMDLJc5Kdw",
    "createdBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}