이 콘텐츠는 선택한 언어로 제공되지 않습니다.

Chapter 11. Configure Red Hat Developer Hub events module


You can enable real-time updates for GitHub entities by configuring the Events Module with webhooks together with scheduled updates.

Important

These features are for Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.

11.1. Configure the GitHub Events Module plugin

Configure GitHub webhooks to trigger real-time updates for GitHub Discovery and organizational data.

Learn how to configure Events Module for use with the RHDH GitHub Discovery feature and GitHub organization data.

Prerequisites

  • You have added your GitHub integration credentials in the app-config.yaml file.
  • You have defined the schedule.frequency in the app-config.yaml file as longer time period, such as 24 hours.
  • For GitHub Discovery only: You have enabled GitHub Discovery.
  • For GitHub Organizational Data only: You have enabled Github Authentication with user ingestion.

Procedure

  1. Add the GitHub Events Module to your dynamic-plugins.yaml configuration file as follows:

    data:
    dynamic-plugins.yaml: |
    includes:
    - dynamic-plugins.default.yaml
    plugins:
    - package: oci://registry.access.redhat.com/rhdh/backstage-plugin-events-backend-module-github@sha256:2c1ccc4fb01883dc4da1aa0c417d6e28d944c6ce941454ee41698f2c1812035c
    disabled: false
  2. To create HTTP endpoints to receive events for the github, add the following to your app-config.yaml file:

    events:
      http:
       topics:
        - github
      modules:
        github:
          webhookSecret: ${GITHUB_WEBHOOK_SECRET}
    Important

    Secure your workflow by adding a webhook secret token to validate webhook deliveries.

  3. Create a GitHub webhook with the following specifications:

    • For GitHub Discovery Events: push, repository
    • For GitHub Organizational Data Events: organization, team and membership
    • Content Type: application/json
    • Payload URL: https://<my_developer_hub_domain>/api/events/http/github

      Note

      Payload URL is the URL exposed after configuring the HTTP endpoint.

Verification

  • Check the log for an entry that confirms that http endpoint was set up successfully to receive events from the GitHub webhook.

    Example of a log of successfully set up http endpoint
    {"level":"\u001b[32minfo\u001b[39m","message":"Registered /api/events/http/github to receive events","plugin":"events","service":"backstage","timestamp":"2025-11-03 02:19:12"}
  • For GitHub Discovery only:

    • Trigger a GitHub push event by adding, modifying or deleting the catalog-info.yaml file in the repository where you set up your webhook. A record of this event should appear in the pod logs of your RHDH instance.

      Example of a log with changes to catalog-info.yaml file
      {"level":"\u001b[32minfo\u001b[39m","message":"Processed Github push event: added 0 - removed 0 - modified 1","plugin":"catalog","service":"backstage","span_id":"47534b96c4afc654","target":"github-provider:providerId","timestamp":"2025-06-15 21:33:14","trace_flags":"01","trace_id":"ecc782deb86aed2027da0ae6b1999e5c"}
  • For GitHub Organizational Data only:

    • Newly added users and teams appear in the RHDH catalog.
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 문서 정보

Legal Notice

Theme

© 2026 Red Hat
맨 위로 이동