Skip to content

EVENTS.md

Latest commit

 

History

History
163 lines (124 loc) · 5.78 KB

EVENTS.md

File metadata and controls

163 lines (124 loc) · 5.78 KB

GitHub Webhook Events Reference

This document lists all GitHub webhook events that are NOT essential for core GitOps deployment workflows. These events are available but not prioritized for implementation in this library.

Collaboration & Project Management

Issues & Comments

  • issues - Issue opened, closed, edited, assigned, etc.
  • issue_comment - Comment on issue or pull request
  • commit_comment - Comment on a commit

Pull Request Reviews

  • pull_request_review - Pull request review submitted
  • pull_request_review_comment - Comment on PR diff
  • pull_request_review_thread - PR review thread activity

Projects

  • project - Project (classic) created, edited, deleted
  • project_card - Project card moved, created, deleted
  • project_column - Project column created, updated, deleted
  • projects_v2 - Project (new) activity
  • projects_v2_item - Project item activity
  • projects_v2_status_update - Project status update

Discussions

  • discussion - Discussion created, edited, deleted, etc.
  • discussion_comment - Comment on a discussion

Other Collaboration

  • label - Label created, edited, deleted
  • milestone - Milestone created, edited, deleted, etc.
  • gollum - Wiki page created or updated

Repository & Organization Management

Repository Events

  • repository - Repository created, deleted, archived, renamed, etc.
  • repository_dispatch - Custom webhook event triggered via API
  • repository_import - Repository import activity
  • public - Repository visibility changed to public
  • fork - Repository forked

Team & Member Management

  • member - Collaborator added, removed, or permissions changed
  • membership - User added/removed from team
  • team - Team created, deleted, edited
  • team_add - Team added to repository
  • organization - Organization settings changed
  • org_block - User blocked/unblocked from organization

Repository Settings

  • branch_protection_rule - Branch protection rule created, edited, deleted
  • branch_protection_configuration - Branch protection configuration changed
  • repository_ruleset - Repository ruleset activity
  • deploy_key - Deploy key added or removed
  • custom_property - Custom property changed
  • custom_property_values - Custom property values updated

Security & Compliance

Security Alerts

  • code_scanning_alert - Code scanning alert created, fixed, dismissed
  • secret_scanning_alert - Secret detected in code
  • secret_scanning_alert_location - Secret location detected
  • secret_scanning_scan - Secret scanning scan completed
  • dependabot_alert - Dependabot alert created, fixed, dismissed
  • repository_vulnerability_alert - Vulnerability alert (legacy)

Security Advisory

  • security_advisory - Security advisory published
  • repository_advisory - Repository security advisory
  • security_and_analysis - Security and analysis settings changed

Deployment Protection

  • deployment_protection_rule - Deployment protection rule activity
  • deployment_review - Deployment review requested/approved

GitHub Apps & Integrations

Installation

  • installation - GitHub App installed, uninstalled, suspended
  • installation_repositories - Repositories added/removed from installation
  • installation_target - Installation moved to different account
  • github_app_authorization - User authorizes/revokes GitHub App

Workflow Management

  • workflow_dispatch - Workflow manually triggered (for workflow visibility, not deployment)
  • workflow_job - Individual job status (detailed monitoring, not essential for GitOps)

Metadata

  • meta - Webhook itself is modified or deleted

Community & Engagement

  • star - Repository starred or unstarred
  • watch - User starts/stops watching repository
  • sponsorship - Sponsorship tier created, cancelled, changed

Package Management

  • package - GitHub Packages published, updated, deleted
  • registry_package - Container registry package activity

GitHub Pages

  • page_build - GitHub Pages site build attempt (success/failure)

Marketplace

  • marketplace_purchase - GitHub Marketplace app purchased, cancelled, changed

Other Events

  • merge_group - Merge queue activity
  • personal_access_token_request - PAT request in organization
  • sub_issues - Sub-issue activity (tasklists)
  • issue_dependencies - Issue dependency tracking

Notes

Total events: 65

These events are useful for:

  • Building GitHub dashboards and analytics
  • Issue/PR automation and bots
  • Security monitoring and compliance
  • Team collaboration tools
  • Community engagement tracking
  • Project management automation

However, they are not required for the core GitOps use case of:

  1. Syncing manifest repositories
  2. Managing deployment environments
  3. Tracking deployment status
  4. Triggering deployments on code changes

Using Unknown Events

The library handles all these events gracefully:

match event {
    WebhookEvent::Push(push_event) => {
        // Handle GitOps sync
    }
    WebhookEvent::Unknown(event_type) => {
        // Log and ignore non-essential events
        println!("Received non-essential event: {}", event_type);
    }
    _ => {}
}

If you need to implement any of these events, you can:

  1. Add the event struct to webhook.rs
  2. Add a variant to WebhookEvent enum
  3. Add parsing logic to WebhookVerifier::parse_event()
  4. Submit a PR to the library

Resources