> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create workflow

> Create a workflow source file in the project source or a preview branch when a new multi-step process must be runnable or schedulable; returns the workflow source document.

`createWorkflow(projectReference: String!, input: CreateWorkflowInput!): WorkflowSource!`

Requires project.runs.write.

## Arguments

| Argument | Type | Required |
| - | - | - |
| `projectReference` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes |
| `input` | [`CreateWorkflowInput!`](https://veryfront.com/docs/cloud/graphql/types/createworkflowinput) | Yes |

## Input fields

### input

[`CreateWorkflowInput`](https://veryfront.com/docs/cloud/graphql/types/createworkflowinput)

| Field | Type | Required | Description |
| - | - | - | - |
| `id` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | Becomes the file name and the workflow id; the workflow name is derived from it. |
| `description` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | |
| `version` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | |
| `schedulable` | [`Boolean`](https://veryfront.com/docs/cloud/graphql/types/boolean) | No | Whether a schedule can start the workflow; default true. |
| `sourceTargetKind` | [`WriteTargetKind`](https://veryfront.com/docs/cloud/graphql/types/writetargetkind) | No | The source to write; default project. |
| `targetBranchId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No | Required with the kind preview\_branch. |

## Response

Returns [`WorkflowSource!`](https://veryfront.com/docs/cloud/graphql/types/workflowsource). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `id` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | |
| `name` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `description` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `target` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `sourcePath` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `source` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | The source text of the workflow file. |
| `version` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `schedulable` | [`Boolean!`](https://veryfront.com/docs/cloud/graphql/types/boolean) | |

[All fields of `WorkflowSource`](https://veryfront.com/docs/cloud/graphql/types/workflowsource).

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
mutation CreateWorkflow($projectReference: String!, $input: CreateWorkflowInput!) {
  createWorkflow(projectReference: $projectReference, input: $input) {
    id
    name
    description
    editMode
    schedulable
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "input": {
    "id": "example"
  }
}
```

<details>
  <summary>Try this mutation</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Mutation

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.