# GitHub events (https://www.shipfox.io/docs/integrations/github/events)

Description: See which GitHub events can start a workflow and what each event contains.

## Event catalog [#event-catalog]

Use your GitHub integration connection slug instead of `github_acme`.

Shipfox also delivers GitHub events that are not listed here. See [every GitHub event](https://docs.github.com/en/webhooks/webhook-events-and-payloads).

### Push

Changes to a branch or tag.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#push)

#### `push`

A branch or tag changes.

```yaml
triggers:
  on_push:
    source: github_acme
    event: push
```

### Pull requests

Changes to a pull request.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request)

#### `pull_request.opened`

A pull request opens.

```yaml
triggers:
  on_pull_request_opened:
    source: github_acme
    event: pull_request.opened
```

#### `pull_request.closed`

A pull request closes or merges.

```yaml
triggers:
  on_pull_request_closed:
    source: github_acme
    event: pull_request.closed
```

#### `pull_request.synchronize`

A pull request head branch receives commits.

```yaml
triggers:
  on_pull_request_synchronize:
    source: github_acme
    event: pull_request.synchronize
```

#### `pull_request.reopened`

A closed pull request reopens.

```yaml
triggers:
  on_pull_request_reopened:
    source: github_acme
    event: pull_request.reopened
```

#### `pull_request.assigned`

A pull request is assigned to a user.

```yaml
triggers:
  on_pull_request_assigned:
    source: github_acme
    event: pull_request.assigned
```

#### `pull_request.unassigned`

A user is unassigned from a pull request.

```yaml
triggers:
  on_pull_request_unassigned:
    source: github_acme
    event: pull_request.unassigned
```

#### `pull_request.labeled`

A label is added to a pull request.

```yaml
triggers:
  on_pull_request_labeled:
    source: github_acme
    event: pull_request.labeled
```

#### `pull_request.unlabeled`

A label is removed from a pull request.

```yaml
triggers:
  on_pull_request_unlabeled:
    source: github_acme
    event: pull_request.unlabeled
```

#### `pull_request.edited`

A pull request title, body, or branch changes.

```yaml
triggers:
  on_pull_request_edited:
    source: github_acme
    event: pull_request.edited
```

#### `pull_request.converted_to_draft`

A pull request is converted to draft.

```yaml
triggers:
  on_pull_request_converted_to_draft:
    source: github_acme
    event: pull_request.converted_to_draft
```

#### `pull_request.locked`

Conversation on a pull request is locked.

```yaml
triggers:
  on_pull_request_locked:
    source: github_acme
    event: pull_request.locked
```

#### `pull_request.unlocked`

Conversation on a pull request is unlocked.

```yaml
triggers:
  on_pull_request_unlocked:
    source: github_acme
    event: pull_request.unlocked
```

#### `pull_request.enqueued`

A pull request is added to the merge queue.

```yaml
triggers:
  on_pull_request_enqueued:
    source: github_acme
    event: pull_request.enqueued
```

#### `pull_request.dequeued`

A pull request is removed from the merge queue.

```yaml
triggers:
  on_pull_request_dequeued:
    source: github_acme
    event: pull_request.dequeued
```

#### `pull_request.milestoned`

A pull request is added to a milestone.

```yaml
triggers:
  on_pull_request_milestoned:
    source: github_acme
    event: pull_request.milestoned
```

#### `pull_request.demilestoned`

A pull request is removed from a milestone.

```yaml
triggers:
  on_pull_request_demilestoned:
    source: github_acme
    event: pull_request.demilestoned
```

#### `pull_request.ready_for_review`

A draft pull request is marked ready for review.

```yaml
triggers:
  on_pull_request_ready_for_review:
    source: github_acme
    event: pull_request.ready_for_review
```

#### `pull_request.review_requested`

A review is requested on a pull request.

```yaml
triggers:
  on_pull_request_review_requested:
    source: github_acme
    event: pull_request.review_requested
```

#### `pull_request.review_request_removed`

A pull request review request is removed.

```yaml
triggers:
  on_pull_request_review_request_removed:
    source: github_acme
    event: pull_request.review_request_removed
```

#### `pull_request.auto_merge_enabled`

Auto-merge is enabled for a pull request.

```yaml
triggers:
  on_pull_request_auto_merge_enabled:
    source: github_acme
    event: pull_request.auto_merge_enabled
```

#### `pull_request.auto_merge_disabled`

Auto-merge is disabled for a pull request.

```yaml
triggers:
  on_pull_request_auto_merge_disabled:
    source: github_acme
    event: pull_request.auto_merge_disabled
```

### Pull request reviews

Reviews on a pull request.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review)

#### `pull_request_review.submitted`

A pull request review is submitted.

```yaml
triggers:
  on_pull_request_review_submitted:
    source: github_acme
    event: pull_request_review.submitted
```

#### `pull_request_review.edited`

A pull request review is edited.

```yaml
triggers:
  on_pull_request_review_edited:
    source: github_acme
    event: pull_request_review.edited
```

#### `pull_request_review.dismissed`

A pull request review is dismissed.

```yaml
triggers:
  on_pull_request_review_dismissed:
    source: github_acme
    event: pull_request_review.dismissed
```

### Pull request review comments

Comments on a pull request diff.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review_comment)

#### `pull_request_review_comment.created`

A comment on a pull request diff is created.

```yaml
triggers:
  on_pull_request_review_comment_created:
    source: github_acme
    event: pull_request_review_comment.created
```

#### `pull_request_review_comment.edited`

A comment on a pull request diff is edited.

```yaml
triggers:
  on_pull_request_review_comment_edited:
    source: github_acme
    event: pull_request_review_comment.edited
```

#### `pull_request_review_comment.deleted`

A comment on a pull request diff is deleted.

```yaml
triggers:
  on_pull_request_review_comment_deleted:
    source: github_acme
    event: pull_request_review_comment.deleted
```

### Pull request review threads

Review threads that are resolved or marked unresolved.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#pull_request_review_thread)

#### `pull_request_review_thread.resolved`

A pull request review thread is resolved.

```yaml
triggers:
  on_pull_request_review_thread_resolved:
    source: github_acme
    event: pull_request_review_thread.resolved
```

#### `pull_request_review_thread.unresolved`

A pull request review thread is marked unresolved.

```yaml
triggers:
  on_pull_request_review_thread_unresolved:
    source: github_acme
    event: pull_request_review_thread.unresolved
```

### Issue comments

Comments on an issue or on the conversation tab of a pull request.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#issue_comment)

#### `issue_comment.created`

A comment on an issue or pull request is created.

```yaml
triggers:
  on_issue_comment_created:
    source: github_acme
    event: issue_comment.created
```

#### `issue_comment.edited`

A comment on an issue or pull request is edited.

```yaml
triggers:
  on_issue_comment_edited:
    source: github_acme
    event: issue_comment.edited
```

#### `issue_comment.deleted`

A comment on an issue or pull request is deleted.

```yaml
triggers:
  on_issue_comment_deleted:
    source: github_acme
    event: issue_comment.deleted
```

### Issues

Changes to an issue.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#issues)

#### `issues.opened`

An issue opens.

```yaml
triggers:
  on_issues_opened:
    source: github_acme
    event: issues.opened
```

#### `issues.closed`

An issue closes.

```yaml
triggers:
  on_issues_closed:
    source: github_acme
    event: issues.closed
```

#### `issues.reopened`

A closed issue reopens.

```yaml
triggers:
  on_issues_reopened:
    source: github_acme
    event: issues.reopened
```

#### `issues.edited`

An issue title or body changes.

```yaml
triggers:
  on_issues_edited:
    source: github_acme
    event: issues.edited
```

#### `issues.labeled`

A label is added to an issue.

```yaml
triggers:
  on_issues_labeled:
    source: github_acme
    event: issues.labeled
```

#### `issues.unlabeled`

A label is removed from an issue.

```yaml
triggers:
  on_issues_unlabeled:
    source: github_acme
    event: issues.unlabeled
```

#### `issues.assigned`

An issue is assigned to a user.

```yaml
triggers:
  on_issues_assigned:
    source: github_acme
    event: issues.assigned
```

#### `issues.unassigned`

A user is unassigned from an issue.

```yaml
triggers:
  on_issues_unassigned:
    source: github_acme
    event: issues.unassigned
```

#### `issues.deleted`

An issue is deleted.

```yaml
triggers:
  on_issues_deleted:
    source: github_acme
    event: issues.deleted
```

#### `issues.transferred`

An issue is transferred to another repository.

```yaml
triggers:
  on_issues_transferred:
    source: github_acme
    event: issues.transferred
```

#### `issues.pinned`

An issue is pinned.

```yaml
triggers:
  on_issues_pinned:
    source: github_acme
    event: issues.pinned
```

#### `issues.unpinned`

An issue is unpinned.

```yaml
triggers:
  on_issues_unpinned:
    source: github_acme
    event: issues.unpinned
```

#### `issues.locked`

Conversation on an issue is locked.

```yaml
triggers:
  on_issues_locked:
    source: github_acme
    event: issues.locked
```

#### `issues.unlocked`

Conversation on an issue is unlocked.

```yaml
triggers:
  on_issues_unlocked:
    source: github_acme
    event: issues.unlocked
```

#### `issues.milestoned`

An issue is added to a milestone.

```yaml
triggers:
  on_issues_milestoned:
    source: github_acme
    event: issues.milestoned
```

#### `issues.demilestoned`

An issue is removed from a milestone.

```yaml
triggers:
  on_issues_demilestoned:
    source: github_acme
    event: issues.demilestoned
```

#### `issues.typed`

An issue type is added to an issue.

```yaml
triggers:
  on_issues_typed:
    source: github_acme
    event: issues.typed
```

#### `issues.untyped`

An issue type is removed from an issue.

```yaml
triggers:
  on_issues_untyped:
    source: github_acme
    event: issues.untyped
```

#### `issues.field_added`

A field is added to an issue.

```yaml
triggers:
  on_issues_field_added:
    source: github_acme
    event: issues.field_added
```

#### `issues.field_removed`

A field is removed from an issue.

```yaml
triggers:
  on_issues_field_removed:
    source: github_acme
    event: issues.field_removed
```

### Releases

Changes to a release.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#release)

#### `release.published`

A release is published.

```yaml
triggers:
  on_release_published:
    source: github_acme
    event: release.published
```

#### `release.unpublished`

A release is unpublished.

```yaml
triggers:
  on_release_unpublished:
    source: github_acme
    event: release.unpublished
```

#### `release.created`

A draft release is created or saved.

```yaml
triggers:
  on_release_created:
    source: github_acme
    event: release.created
```

#### `release.edited`

A release is edited.

```yaml
triggers:
  on_release_edited:
    source: github_acme
    event: release.edited
```

#### `release.deleted`

A release is deleted.

```yaml
triggers:
  on_release_deleted:
    source: github_acme
    event: release.deleted
```

#### `release.prereleased`

A release is published as a pre-release.

```yaml
triggers:
  on_release_prereleased:
    source: github_acme
    event: release.prereleased
```

#### `release.released`

A release is published from a pre-release.

```yaml
triggers:
  on_release_released:
    source: github_acme
    event: release.released
```

### Workflow jobs

Progress of a GitHub Actions job.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#workflow_job)

#### `workflow_job.completed`

A job in a workflow run finishes.

```yaml
triggers:
  on_workflow_job_completed:
    source: github_acme
    event: workflow_job.completed
```

#### `workflow_job.in_progress`

A job in a workflow run started processing on a runner.

```yaml
triggers:
  on_workflow_job_in_progress:
    source: github_acme
    event: workflow_job.in_progress
```

#### `workflow_job.queued`

A job in a workflow run was created.

```yaml
triggers:
  on_workflow_job_queued:
    source: github_acme
    event: workflow_job.queued
```

#### `workflow_job.waiting`

A job in a workflow run was created and is waiting for approvals.

```yaml
triggers:
  on_workflow_job_waiting:
    source: github_acme
    event: workflow_job.waiting
```

### Workflow runs

Progress of a GitHub Actions run.

**Payload:** Fields from GitHub. [GitHub docs](https://docs.github.com/en/webhooks/webhook-events-and-payloads#workflow_run)

#### `workflow_run.completed`

A workflow run finishes.

```yaml
triggers:
  on_workflow_run_completed:
    source: github_acme
    event: workflow_run.completed
```

#### `workflow_run.in_progress`

A workflow run started processing on a runner.

```yaml
triggers:
  on_workflow_run_in_progress:
    source: github_acme
    event: workflow_run.in_progress
```

#### `workflow_run.requested`

A workflow run was triggered.

```yaml
triggers:
  on_workflow_run_requested:
    source: github_acme
    event: workflow_run.requested
```