Capture GitHub events to:

  • Track issues and PRs opened by your customers
  • Track new features from code changes
  • Identify when new code changes lead to system alerts or build failures

Ship Github Events to

Before you begin, you’ll need: Admin permissions to the GitHub project

Add a webhook to your GitHub project

Open your GitHub project. On your project page, go to Setting > Webhooks and select Add webhook.

How to add a GitHub webhook

Add your payload url

For the Payload url, use either of the following formats. You can send your data encrypted via HTTPS, or unencrypted, via HTTP:

For HTTPS shipping
For HTTP shipping

Replace <<LOG-SHIPPING-TOKEN>> with the token of the account you want to ship to.

Replace <<LISTENER-HOST>> with the host for your region. For example, if your account is hosted on AWS US East, or if hosted on Azure West Europe. The required port depends whether HTTP or HTTPS is used: HTTP = 8070, HTTPS = 8071.

Configure your webhook

Complete filling in the form:

  1. Content Type: Select application/json.
  2. Secret: Leave it blank. Your account token is used to securely route your logs to your account.
  3. SSL verification: We recommend enabling SSL verification.
  4. Select your event triggers. The options available are:
    • Just the push event
    • Send me everything
    • Let me select individual events. A checklist will appear for you to make your selections.
  5. Active. Make sure this checkbox is enabled.
  6. Click Add webhook to save your webhook.
Check for your logs

Give your logs some time to get from your system to ours, and then open Open Search Dashboards. Search for type:github in Open Search Dashboards Discover to filter for your GitHub events. Your logs should be already parsed thanks to the preconfigured parsing pipeline.

If you still don’t see your logs, see log shipping troubleshooting.