PRprocess
Workflow Widgets

Create a widget

Changed on

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

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/workflows/{workflowId}/revisions/{revisionId}/tasks/{taskId}/widgets
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

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": "qB2llZ1xDP0BoZxtcpJ9iw",
    "taskId": "qB2llZ1xDP0BoZxtcpJ9iw",
    "createdBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "paiZa0_oyxEBoZxtatp33g",
      "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"
    }
  ]
}

Changes

  • dd5abc01b106Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property /

  • 3b0d0ecad0eeRevision changes
    • info

      added the new optional request property /