GitHub events

This reference lists GitHub event names that Shipfox delivers to a GitHub integration connection. See the GitHub overview for availability and setup.

Payload

Shipfox passes the raw GitHub webhook payload to a run as event. GitHub owns the payload schema and can add fields. Use the GitHub webhook events and payloads reference for its full schema.

Trigger fragment

Replace github_acme with the integration connection slug:

triggers:
  on_push:
    source: github_acme
    event: push

For trigger field rules, see the workflow schema reference.

Event catalog

Shipfox forwards additional raw GitHub webhook events. See the complete GitHub event reference for the upstream catalog.

push

A Git reference receives one or more commits.

Emitted when: GitHub sends a push webhook to the connected GitHub App.

Payload: Raw provider payload.

Provider payload documentation

pull_request.opened

A pull request opens.

Emitted when: GitHub sends a pull_request webhook with the opened action.

Payload: Raw provider payload.

Provider payload documentation

pull_request.closed

A pull request closes or merges.

Emitted when: GitHub sends a pull_request webhook with the closed action.

Payload: Raw provider payload.

Provider payload documentation

pull_request.synchronize

A pull request head branch receives commits.

Emitted when: GitHub sends a pull_request webhook with the synchronize action.

Payload: Raw provider payload.

Provider payload documentation

pull_request.reopened

A closed pull request reopens.

Emitted when: GitHub sends a pull_request webhook with the reopened action.

Payload: Raw provider payload.

Provider payload documentation

issues.opened

An issue opens.

Emitted when: GitHub sends an issues webhook with the opened action.

Payload: Raw provider payload.

Provider payload documentation

issues.closed

An issue closes.

Emitted when: GitHub sends an issues webhook with the closed action.

Payload: Raw provider payload.

Provider payload documentation

issues.reopened

A closed issue reopens.

Emitted when: GitHub sends an issues webhook with the reopened action.

Payload: Raw provider payload.

Provider payload documentation

issues.edited

An issue title or body changes.

Emitted when: GitHub sends an issues webhook with the edited action.

Payload: Raw provider payload.

Provider payload documentation

issues.labeled

A label is added to an issue.

Emitted when: GitHub sends an issues webhook with the labeled action.

Payload: Raw provider payload.

Provider payload documentation

issues.unlabeled

A label is removed from an issue.

Emitted when: GitHub sends an issues webhook with the unlabeled action.

Payload: Raw provider payload.

Provider payload documentation

release.published

A release is published.

Emitted when: GitHub sends a release webhook with the published action.

Payload: Raw provider payload.

Provider payload documentation