Action: Cancel Maestro Workflow Instance

Docusign Operation

The Cancel Maestro Workflow Instance action cancels an active Maestro workflow instance, stopping its execution.

Example User Story

I want to cancel a running Maestro workflow instance to halt an erroneous or outdated document process.

Fields

Field Name	Field Type	Required
workflowInstanceId	String	Yes
accessToken	String	Yes
status	String	No

Related Connections

Docusign

Related Automations

Example link

Code (Apache v2.0): Operation

{
  "handle": "cancel-maestro-workflow-instance",
  "state": "inDev",
  "meta": {
    "short": "Cancel Maestro Workflow Instance",
    "description": "Cancels a running Maestro workflow instance in Docusign."
  },
  "input": [
    {
      "name": "workflowInstanceId",
      "type": "String",
      "required": true,
      "meta": {
        "description": "The ID of the workflow instance to cancel."
      }
    }
  ],
  "output": [
    {
      "name": "status",
      "type": "String",
      "selector": ["status"],
      "meta": {
        "description": "The status of the cancellation request."
      }
    }
  ],
  "steps": [
    {
      "type": "http",
      "http": {
        "method": "POST",
        "path": "/maestro/workflowInstances/{{workflowInstanceId}}/cancel",
        "headers": {
          "Content-Type": "application/json"
        },
        "bodyTemplate": {
          "value": "{}",
          "placeholders": [
            {
              "name": "accessToken",
              "type": "String",
              "description": "The access token for authenticating with Docusign.",
              "required": true
            }
          ]
        }
      }
    }
  ]
}