GitHub events
Look up the GitHub event names Shipfox delivers and the raw payload behavior for each event.
This reference lists GitHub event names that Shipfox delivers to a GitHub integration connection. See the GitHub overview for authentication 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 slug of your GitHub integration connection:
triggers:
on_push:
source: github_acme
event: pushFor 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
pull_request.assigned
A pull request is assigned to a user.
Emitted when: GitHub sends a pull_request webhook with the assigned action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.unassigned
A user is unassigned from a pull request.
Emitted when: GitHub sends a pull_request webhook with the unassigned action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.labeled
A label is added to a pull request.
Emitted when: GitHub sends a pull_request webhook with the labeled action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.unlabeled
A label is removed from a pull request.
Emitted when: GitHub sends a pull_request webhook with the unlabeled action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.edited
A pull request title, body, or branch changes.
Emitted when: GitHub sends a pull_request webhook with the edited action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.converted_to_draft
A pull request is converted to draft.
Emitted when: GitHub sends a pull_request webhook with the converted_to_draft action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.locked
Conversation on a pull request is locked.
Emitted when: GitHub sends a pull_request webhook with the locked action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.unlocked
Conversation on a pull request is unlocked.
Emitted when: GitHub sends a pull_request webhook with the unlocked action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.enqueued
A pull request is added to the merge queue.
Emitted when: GitHub sends a pull_request webhook with the enqueued action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.dequeued
A pull request is removed from the merge queue.
Emitted when: GitHub sends a pull_request webhook with the dequeued action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.milestoned
A pull request is added to a milestone.
Emitted when: GitHub sends a pull_request webhook with the milestoned action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.demilestoned
A pull request is removed from a milestone.
Emitted when: GitHub sends a pull_request webhook with the demilestoned action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.ready_for_review
A draft pull request is marked ready for review.
Emitted when: GitHub sends a pull_request webhook with the ready_for_review action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.review_requested
A review is requested on a pull request.
Emitted when: GitHub sends a pull_request webhook with the review_requested action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.review_request_removed
A pull request review request is removed.
Emitted when: GitHub sends a pull_request webhook with the review_request_removed action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.auto_merge_enabled
Auto-merge is enabled for a pull request.
Emitted when: GitHub sends a pull_request webhook with the auto_merge_enabled action.
Payload: Raw provider payload.
Provider payload documentation
pull_request.auto_merge_disabled
Auto-merge is disabled for a pull request.
Emitted when: GitHub sends a pull_request webhook with the auto_merge_disabled action.
Payload: Raw provider payload.
Provider payload documentation
pull_request_review_comment.created
A comment on a pull request diff is created.
Emitted when: GitHub sends a pull_request_review_comment webhook with the created action.
Payload: Raw provider payload.
Provider payload documentation
pull_request_review_comment.edited
A comment on a pull request diff is edited.
Emitted when: GitHub sends a pull_request_review_comment webhook with the edited action.
Payload: Raw provider payload.
Provider payload documentation
pull_request_review_comment.deleted
A comment on a pull request diff is deleted.
Emitted when: GitHub sends a pull_request_review_comment webhook with the deleted action.
Payload: Raw provider payload.
Provider payload documentation
issues.opened
An issue opens.
Emitted when: GitHub sends a issues webhook with the opened action.
Payload: Raw provider payload.
Provider payload documentation
issues.closed
An issue closes.
Emitted when: GitHub sends a issues webhook with the closed action.
Payload: Raw provider payload.
Provider payload documentation
issues.reopened
A closed issue reopens.
Emitted when: GitHub sends a 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 a 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 a 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 a issues webhook with the unlabeled action.
Payload: Raw provider payload.
Provider payload documentation
issues.assigned
An issue is assigned to a user.
Emitted when: GitHub sends a issues webhook with the assigned action.
Payload: Raw provider payload.
Provider payload documentation
issues.unassigned
A user is unassigned from an issue.
Emitted when: GitHub sends a issues webhook with the unassigned action.
Payload: Raw provider payload.
Provider payload documentation
issues.deleted
An issue is deleted.
Emitted when: GitHub sends a issues webhook with the deleted action.
Payload: Raw provider payload.
Provider payload documentation
issues.transferred
An issue is transferred to another repository.
Emitted when: GitHub sends a issues webhook with the transferred action.
Payload: Raw provider payload.
Provider payload documentation
issues.pinned
An issue is pinned.
Emitted when: GitHub sends a issues webhook with the pinned action.
Payload: Raw provider payload.
Provider payload documentation
issues.unpinned
An issue is unpinned.
Emitted when: GitHub sends a issues webhook with the unpinned action.
Payload: Raw provider payload.
Provider payload documentation
issues.locked
Conversation on an issue is locked.
Emitted when: GitHub sends a issues webhook with the locked action.
Payload: Raw provider payload.
Provider payload documentation
issues.unlocked
Conversation on an issue is unlocked.
Emitted when: GitHub sends a issues webhook with the unlocked action.
Payload: Raw provider payload.
Provider payload documentation
issues.milestoned
An issue is added to a milestone.
Emitted when: GitHub sends a issues webhook with the milestoned action.
Payload: Raw provider payload.
Provider payload documentation
issues.demilestoned
An issue is removed from a milestone.
Emitted when: GitHub sends a issues webhook with the demilestoned action.
Payload: Raw provider payload.
Provider payload documentation
issues.typed
An issue type is added to an issue.
Emitted when: GitHub sends a issues webhook with the typed action.
Payload: Raw provider payload.
Provider payload documentation
issues.untyped
An issue type is removed from an issue.
Emitted when: GitHub sends a issues webhook with the untyped action.
Payload: Raw provider payload.
Provider payload documentation
issues.field_added
A field is added to an issue.
Emitted when: GitHub sends a issues webhook with the field_added action.
Payload: Raw provider payload.
Provider payload documentation
issues.field_removed
A field is removed from an issue.
Emitted when: GitHub sends a issues webhook with the field_removed 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
release.unpublished
A release is unpublished.
Emitted when: GitHub sends a release webhook with the unpublished action.
Payload: Raw provider payload.
Provider payload documentation
release.created
A draft release is created or saved.
Emitted when: GitHub sends a release webhook with the created action.
Payload: Raw provider payload.
Provider payload documentation
release.edited
A release is edited.
Emitted when: GitHub sends a release webhook with the edited action.
Payload: Raw provider payload.
Provider payload documentation
release.deleted
A release is deleted.
Emitted when: GitHub sends a release webhook with the deleted action.
Payload: Raw provider payload.
Provider payload documentation
release.prereleased
A release is published as a pre-release.
Emitted when: GitHub sends a release webhook with the prereleased action.
Payload: Raw provider payload.
Provider payload documentation
release.released
A release is published from a pre-release.
Emitted when: GitHub sends a release webhook with the released action.
Payload: Raw provider payload.
Provider payload documentation
workflow_job.completed
A job in a workflow run finishes.
Emitted when: GitHub sends a workflow_job webhook with the completed action.
Payload: Raw provider payload.
Provider payload documentation
workflow_job.in_progress
A job in a workflow run started processing on a runner.
Emitted when: GitHub sends a workflow_job webhook with the in_progress action.
Payload: Raw provider payload.
Provider payload documentation
workflow_job.queued
A job in a workflow run was created.
Emitted when: GitHub sends a workflow_job webhook with the queued action.
Payload: Raw provider payload.
Provider payload documentation
workflow_job.waiting
A job in a workflow run was created and is waiting for approvals.
Emitted when: GitHub sends a workflow_job webhook with the waiting action.
Payload: Raw provider payload.
Provider payload documentation
workflow_run.completed
A workflow run finishes.
Emitted when: GitHub sends a workflow_run webhook with the completed action.
Payload: Raw provider payload.
Provider payload documentation
workflow_run.in_progress
A workflow run started processing on a runner.
Emitted when: GitHub sends a workflow_run webhook with the in_progress action.
Payload: Raw provider payload.
Provider payload documentation
workflow_run.requested
A workflow run was triggered.
Emitted when: GitHub sends a workflow_run webhook with the requested action.
Payload: Raw provider payload.
Provider payload documentation