GitHub Integration Reference

Shipfox receives repository events through a GitHub App. Connect GitHub creates the integration connection used here.

Integration connection identity

A GitHub integration connection slug defaults to github_<account>, such as github_acme. Use the actual workspace integration connection slug as a trigger's source.

This trigger fragment belongs under an existing workflow's triggers map:

triggers:
  on_push:
    source: github_acme # Replace with your GitHub integration connection slug.
    event: push

Events

The common event is push. Shipfox also forwards GitHub App events. Their names use <resource> or <resource>.<action>. Examples include pull_request.opened, issues.opened, and release.published.

GitHub owns the complete event catalog and payload definitions:

Event payload

Shipfox gives the raw GitHub webhook body to the run as event. A push event includes the full Git ref. It also includes the head commit, repository, and default branch fields sent by GitHub.

The branch ref uses the full Git form, such as refs/heads/main.

Filtering

A trigger filter can narrow events before run creation. This fragment accepts pushes to main only:

triggers:
  on_main_push:
    source: github_acme # Replace with your GitHub integration connection slug.
    event: push
    filter: event.ref == "refs/heads/main"

The Expressions reference defines evaluation and failure behavior. Checks on every push provides a complete workflow.