Configure the GitHub Events Module plugin
Configure GitHub webhooks to trigger real-time updates for GitHub Discovery and organizational data.
Before you begin
- You have added your GitHub integration credentials in the
app-config.yamlfile. - You have defined the
schedule.frequencyin theapp-config.yamlfile 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.
About this task
Learn how to configure Events Module for use with the RHDH GitHub Discovery feature and GitHub organization data.
Procedure
Results
- 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.yamlfile 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.yamlfile -
{"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"}
- Example of a log with changes to
- Trigger a GitHub push event by adding, modifying or deleting the
- For GitHub Organizational Data only:
- Newly added users and teams appear in the RHDH catalog.