← Back to Hook Line Sinker

GitHub Events Reference

Complete guide to GitHub webhook events and their payloads

push
Triggered when commits are pushed to a repository
Always triggered (no actions)
Contains: commits, pusher, before/after SHAs, ref
pull_request
Activity on pull requests
Actions:
  • opened, closed, reopened
  • edited, assigned, unassigned
  • review_requested, review_request_removed
  • labeled, unlabeled
  • synchronized (new commits)
Contains: pull_request object, changes, requested_reviewers
issues
Activity on repository issues
Actions:
  • opened, closed, reopened
  • edited, assigned, unassigned
  • labeled, unlabeled
  • milestoned, demilestoned
Contains: issue object, changes, assignee
issue_comment
Comments on issues and pull requests
Actions:
  • created, edited, deleted
Contains: comment object, issue object
release
Repository releases
Actions:
  • published, unpublished
  • created, edited, deleted
  • prereleased, released
Contains: release object, assets
create
Branch or tag creation
Always triggered (no actions)
Contains: ref, ref_type (branch/tag), master_branch
delete
Branch or tag deletion
Always triggered (no actions)
Contains: ref, ref_type (branch/tag)
watch
Repository starring
Actions:
  • started (starred)
Contains: sender who starred
fork
Repository forking
Always triggered (no actions)
Contains: forkee (new repository)
gollum
Wiki page updates
Always triggered (no actions)
Contains: pages array with changes
commit_comment
Comments on commits
Actions:
  • created
Contains: comment object, commit SHA
deployment
Deployment creation
Always triggered (no actions)
Contains: deployment object, environment
deployment_status
Deployment status updates
Always triggered (no actions)
Contains: deployment_status, deployment, target_url
check_run
Check runs from GitHub Apps
Actions:
  • created, completed
  • rerequested, requested_action
Contains: check_run object, conclusion, output
check_suite
Check suite updates
Actions:
  • completed, requested
  • rerequested
Contains: check_suite object, pull_requests
status
Commit status updates
Always triggered (no actions)
Contains: state, description, target_url, context
repository
Repository management
Actions:
  • created, deleted, archived
  • unarchived, publicized, privatized
  • edited, renamed, transferred
Contains: repository changes, before/after values
projects_v2
GitHub Projects (Beta) updates
Actions:
  • created, edited, deleted
  • closed, reopened
Contains: projects_v2 object, organization
projects_v2_item
GitHub Projects (Beta) item updates
Actions:
  • created, edited, deleted
  • converted, reordered
  • archived, restored
Contains: projects_v2_item, changes
ping
Webhook test/verification
Always triggered (no actions)
Contains: zen message, webhook config
workflow_run
GitHub Actions workflow execution
Actions:
  • completed, requested
  • in_progress
Contains: workflow_run, conclusion, artifacts_url
workflow_job
GitHub Actions job execution
Actions:
  • queued, in_progress
  • completed
Contains: workflow_job, steps, conclusion