# org.tangled.ci.triggerPipeline

> Published by [tangled.org](https://lexicon.garden/identity/did:plc:wshs7t2adsemcrrd4snkeqli)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.triggerPipeline)
- [Documentation](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.triggerPipeline/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:wshs7t2adsemcrrd4snkeqli/org.tangled.ci.triggerPipeline/examples)

## Definitions

### `org.tangled.ci.triggerPipeline`

**Type**: `procedure`

Trigger a pipeline at an explicit commit. Runs the named workflows, or every workflow defined in the repo when none are named.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `repo` | `string` (did) | Yes | Target repository DID. Auth is checked against this repo. |
| `trigger` | `union` | Yes | Trigger metadata for this dispatch. |
| `workflows` | `array` | No | Workflow names to run. When not provided, every dispatchable workflow is run. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `pipeline` | `string` | Yes | Spindle-local id of the created pipeline |

#### Errors

- **InvalidRequest**: Invalid request parameters

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Trigger a pipeline at an explicit commit. Runs the named workflows, or every workflow defined in the repo when none are named.",
      "errors": [
        {
          "description": "Invalid request parameters",
          "name": "InvalidRequest"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "repo": {
              "description": "Target repository DID. Auth is checked against this repo.",
              "format": "did",
              "type": "string"
            },
            "trigger": {
              "closed": false,
              "description": "Trigger metadata for this dispatch.",
              "refs": [
                "org.tangled.ci.trigger.manual",
                "org.tangled.event.pullRequest"
              ],
              "type": "union"
            },
            "workflows": {
              "description": "Workflow names to run. When not provided, every dispatchable workflow is run.",
              "items": {
                "description": "workflow name",
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "repo",
            "trigger"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "pipeline": {
              "description": "Spindle-local id of the created pipeline",
              "type": "string"
            }
          },
          "required": [
            "pipeline"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "org.tangled.ci.triggerPipeline",
  "lexicon": 1
}
```