# workflow-run

From **GitHub v3 REST API**.

An invocation of a workflow

- Type: `object`

## Properties

### `artifacts_url`

- Required: true
- Type: `string`
- Example: `https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts`

The URL to the artifacts for the workflow run.

### `cancel_url`

- Required: true
- Type: `string`
- Example: `https://api.github.com/repos/github/hello-world/actions/runs/5/cancel`

The URL to cancel the workflow run.

### `check_suite_id`

- Required: false
- Type: `integer`
- Example: `42`

The ID of the associated check suite.

### `check_suite_node_id`

- Required: false
- Type: `string`
- Example: `MDEwOkNoZWNrU3VpdGU0Mg==`

The node ID of the associated check suite.

### `check_suite_url`

- Required: true
- Type: `string`
- Example: `https://api.github.com/repos/github/hello-world/check-suites/12`

The URL to the associated check suite.

### `conclusion`

- Required: true
- Type: `string`
- Nullable: true
- Example: `neutral`

### `created_at`

- Required: true
- Type: `string`
- Format: `date-time`

### `event`

- Required: true
- Type: `string`
- Example: `push`

### `head_branch`

- Required: true
- Type: `string`
- Nullable: true
- Example: `master`

### `head_commit`

- Required: true
- Type: `object`
- Nullable: true

Simple Commit

### `head_repository`

- Required: true
- Type: `object`

Minimal Repository

### `head_repository_id`

- Required: false
- Type: `integer`
- Example: `5`

### `head_sha`

- Required: true
- Type: `string`
- Example: `009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d`

The SHA of the head commit that points to the version of the workflow being run.

### `html_url`

- Required: true
- Type: `string`
- Example: `https://github.com/github/hello-world/suites/4`

### `id`

- Required: true
- Type: `integer`
- Example: `5`

The ID of the workflow run.

### `jobs_url`

- Required: true
- Type: `string`
- Example: `https://api.github.com/repos/github/hello-world/actions/runs/5/jobs`

The URL to the jobs for the workflow run.

### `logs_url`

- Required: true
- Type: `string`
- Example: `https://api.github.com/repos/github/hello-world/actions/runs/5/logs`

The URL to download the logs for the workflow run.

### `name`

- Required: false
- Type: `string`
- Nullable: true
- Example: `Build`

The name of the workflow run.

### `node_id`

- Required: true
- Type: `string`
- Example: `MDEwOkNoZWNrU3VpdGU1`

### `previous_attempt_url`

- Required: false
- Type: `string`
- Nullable: true
- Example: `https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3`

The URL to the previous attempted run of this workflow, if one exists.

### `pull_requests`

- Required: true
- Type: `array`
- Nullable: true

### `repository`

- Required: true
- Type: `object`

Minimal Repository

## JSON Schema

```json
{"description":"An invocation of a workflow","properties":{"artifacts_url":{"description":"The URL to the artifacts for the workflow run.","example":"https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts","type":"string"},"cancel_url":{"description":"The URL to cancel the workflow run.","example":"https://api.github.com/repos/github/hello-world/actions/runs/5/cancel","type":"string"},"check_suite_id":{"description":"The ID of the associated check suite.","example":42,"type":"integer"},"check_suite_node_id":{"description":"The node ID of the associated check suite.","example":"MDEwOkNoZWNrU3VpdGU0Mg==","type":"string"},"check_suite_url":{"description":"The URL to the associated check suite.","example":"https://api.github.com/repos/github/hello-world/check-suites/12","type":"string"},"conclusion":{"example":"neutral","nullable":true,"type":"string"},"created_at":{"format":"date-time","type":"string"},"event":{"example":"push","type":"string"},"head_branch":{"example":"master","nullable":true,"type":"string"},"head_commit":{"$ref":"#/components/schemas/nullable-simple-commit"},"head_repository":{"$ref":"#/components/schemas/minimal-repository"},"head_repository_id":{"example":5,"type":"integer"},"head_sha":{"description":"The SHA of the head commit that points to the version of the workflow being run.","example":"009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d","type":"string"},"html_url":{"example":"https://github.com/github/hello-world/suites/4","type":"string"},"id":{"description":"The ID of the workflow run.","example":5,"type":"integer"},"jobs_url":{"description":"The URL to the jobs for the workflow run.","example":"https://api.github.com/repos/github/hello-world/actions/runs/5/jobs","type":"string"},"logs_url":{"description":"The URL to download the logs for the workflow run.","example":"https://api.github.com/repos/github/hello-world/actions/runs/5/logs","type":"string"},"name":{"description":"The name of the workflow run.","example":"Build","nullable":true,"type":"string"},"node_id":{"example":"MDEwOkNoZWNrU3VpdGU1","type":"string"},"previous_attempt_url":{"description":"The URL to the previous attempted run of this workflow, if one exists.","example":"https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3","nullable":true,"type":"string"},"pull_requests":{"items":{"$ref":"#/components/schemas/pull-request-minimal"},"nullable":true,"type":"array"},"repository":{"$ref":"#/components/schemas/minimal-repository"},"rerun_url":{"description":"The URL to rerun the workflow run.","example":"https://api.github.com/repos/github/hello-world/actions/runs/5/rerun","type":"string"},"run_attempt":{"description":"Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.","example":1,"type":"integer"},"run_number":{"description":"The auto incrementing run number for the workflow run.","example":106,"type":"integer"},"run_started_at":{"description":"The start time of the latest run. Resets on re-run.","format":"date-time","type":"string"},"status":{"example":"completed","nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"},"url":{"description":"The URL to the workflow run.","example":"https://api.github.com/repos/github/hello-world/actions/runs/5","type":"string"},"workflow_id":{"description":"The ID of the parent workflow.","example":5,"type":"integer"},"workflow_url":{"description":"The URL to the workflow.","example":"https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml","type":"string"}},"required":["id","node_id","head_branch","run_number","event","status","conclusion","head_sha","workflow_id","url","html_url","created_at","updated_at","head_commit","head_repository","repository","jobs_url","logs_url","check_suite_url","cancel_url","rerun_url","artifacts_url","workflow_url","pull_requests"],"title":"Workflow Run","type":"object"}
```