Delete Workflow

deleteWorkflow Mutation

Deletes a Workflow definition from the system.

Arguments

Name	Type	Description
id	ID!	The unique identifier of the workflow to delete

Return Type

WorkflowDeletePayload! - Contains information about the deleted workflow.

Return Fields

WorkflowDeletePayload:

Field	Type	Description
deletedID	ID	The ID of the deleted workflow

Usage Example

mutation {
  deleteWorkflow(id: "workflow_123") {
    deletedID
  }
}

JavaScript Example

const DELETE_WORKFLOW = gql`
  mutation DeleteWorkflow($id: ID!) {
    deleteWorkflow(id: $id) {
      deletedID
    }
  }
`;

const { data } = await client.mutate({
  mutation: DELETE_WORKFLOW,
  variables: {
    id: "workflow_123"
  }
});

console.log(`Deleted workflow: ${data.deleteWorkflow.deletedID}`);

Important Notes

• Deleting a workflow definition will prevent new instances from being started

• Existing running workflow instances may continue to execute until completion

• This operation permanently removes the workflow definition and cannot be undone

• Ensure proper authorization before performing this operation

• Consider deactivating the workflow first to stop new instances before deletion

• Associated workflow signals will be disassociated but not deleted

• Review dependencies on this workflow before deletion to avoid breaking other processes