GitHub is often used by engineering and product teams and contains a lot of collaborative aspects of the workflows within these teams. This guide shows you how to configure the events most relevant for company's collabortive workflow analytics.
In this article, we create a webhook integration between GitHub and Flowtrace and show how to configure the relevant events.
Creating a webhook for GitHub organization or repository
Configuring the webhook to send individual events (optional)
To complete this integration you need:
Administrator rights to your GitHub project(s) and/or organization
Administrator access to Flowtrace
1. Creating a webhook for GitHub organization or repository
Creating a webhook in GitHub is easy. You can follow the complete instructions from GitHub's docs.
Before you create a webhook you should consider your repository structure and how to best analyse most of your collaboration across them. We recommend creating a organization wide webhook, which captures all repositories owned by you. You can alternatively create webhooks into all repositories you are interested in. The process is same either way you choose to do it.
Payload URL and Content type
You should access Flowtrace integration page to get the "Payload URL" needed for the webhook. By clicking "Copy webhook URL" you get the unique URL for your Flowtrace integration.
Content type we support is "application/json" and you should select this option. We also recommend you to "send me everything" option for events we want to integrate. You can alternatively configure desire events as descrived in next section of this guide.
2. Configuring the webhook to send individual events
Not all events in GitHub are created equal, and not all of them carry significant collaborative value. You can choose to send us only the events which are triggered by people and indicative of purposeful professional collaboration.
By minimum we recommend any comments and disccusision, pull requests and reviews, and if your team uses GitHub issues, their events.
After you save and enable your newly created webhook, you can test it by opening an issue, creating a comment, or doing another action which triggers an event. You can go to Flowtrace Integration page to confirm we have received the event via "Last active" field.