GitHub Enterprise is a platform that helps businesses of all sizes manage their software development and delivery. It increases productivity, automates processes, and keeps code secure. Additional features such as SAML authentication and internal repositories.

More information can be found at Github Enterprise Cloud Website page.

Integration Method: HTTP Ingestion

Tables: API Activity (6003)

DataBee needs to connect to a github webhook which posts the audit logs.

This integration supports the following event.

Prerequisites

• The user should have access to the DataBee console.

• The user should have admin access in GitHub Enterprise Cloud to configure organization-level webhooks.

Configuration Overview

1. Create a Github Enterprise Cloud Audit feed in the DataBee console and copy HTTP collector details including Endpoint URL, API key and Datafeed ID.

2. Configure Organization level GitHub Webhook using details obtained during the Databee feed setup.

DataBee Configuration

Perform the following steps to configure the GitHub Enterprise Cloud using HTTP Ingestion in DataBee Platform.

1. Log into the DataBee console, navigate to Data Feeds inside Data tab.

   

2. Click on Add New Data Feed.

   

3. Search for ‘GitHub Enterprise Cloud Audit’ and click on GitHub Enterprise Cloud Audit.

   

4. Click on HTTP Collector.

   

5. Enter feed contact information.

   

6. In the configuration page, confirm the following and click Next.

   • Format: Select JSON data format option

   

7. Use the Copy to clipboard button to copy the Endpoint URL and Tenant ID for later use, and then click Generate New API Key.

   

8. Use the Copy to clipboard button to copy the API Key and keep it for later use. And click the Submit button.

   

9. Go to Data tab > Data Feeds > Select the configured Data feed > Copy the DataSource ID for later use.

   

GitHub Enterprise Cloud Configuration

• To use the GitHub Enterprise Cloud Audit via http collection, we need to create the Github webhook. As a prerequisite, there must be Enterprise Admin that should have been created, then we must create the Webhook.

• There are multiple types of webhook which can be configured. Among them there is support for Organization Webhook and Repository Webhook in the Databee.

Create Github Webhook

1. Log in to the GitHub Enterprise with Enterprise Admin Credentials and navigate to Profile on top right corner.
    

2. Click on Settings.

3. Go to settings of either organization or repository for which Github Webhook is being configured.

   • For Organization Webhook, click Organizations in the left sidebar. And then click Settings button of the organization for which webhook needs to be configured.

     

   • For Repository Webhook, go to the repository home page for which webhook needs to be configured and then click Settings.

     

4. In the left sidebar of settings, click on Webhooks and then click Add webhook button. (Screenshot refers to Organization settings).

   

5. Enter the following details to create a webhook and click Add webhook button.

   • Payload URL: Paste the endpoint URL from the DataBee configuration steps

     Note:

     Copied Endpoint URL will contain a placeholder for {datafeed_id} and {api_key} which needs to be replaced with previously copied Datasource ID and API-Key.

   • Content-type: application/json

   • Which events would you like to trigger this webhook? - Select Send me everything or Let me select individual events and then check each individual events needs to be posted through a webhook.

     

Troubleshooting Tips

• Ensure payload URL in the GitHub Webhook has correctly replaced Data feed ID and API-key placeholders with actual values.

• Ensure the allowed events in the webhook configuration which will trigger the webhook.

• To ensure successful connection with DataBee http collector, ping the sample event by navigating to edit configured webhook page.

  
  

• Github webhook documentations for reference:

  Github Webhook
  Create Organization Webhook
  Create Repository Webhook