Links

GitHub Integration

Steps to configure GitHub integration for incident management, using Squadcast
GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.
You can use our GitHub integration to route details events from GitHub to the right users in Squadcast.

How to integrate GitHub with Squadcast

In Squadcast: Using GitHub as an Alert Source

  1. 1.
    Navigate to Services -> Service Overview -> select or search for your Service. Expand the accordion -> In the Alert Sources section, click Add.
How to configure GitHub integration in Squadcast
Step 1: Navigate to GitHub integration within a service
2. Select GitHub. Copy the displayed Webhook URL to configure it within GitHub. Finish by clicking Add Alert Source -> Done.
Steps to add Github integration to a service in Squadcast
Step 2: Add GitHub as an alert source for a service
Important:
When an alert source turns Active, it’ll show up under Configured Alert Sources. You can either generate a test alert from the integration or wait for a real-time alert to be generated by the Alert Source. An Alert Source is active if there is a recorded incident via that Alert Source for the Service.

In GitHub: Create a Squadcast Webhook

You can configure a webhook for a group or a project.
1. Click on your user icon on the top right. Under Your repositories or Your organizations, navigate to Settings
How to configure a Squadcast Webhook in GitHub
How to add a Webhook in Github
2. Under the Webhooks section, then select Add webhook
How to add a Webhook in GitHub
3. Paste the previously copied Webhook from Squadcast into the Payload URL field, and select Content type as application/json
Add a Payload URL and Content type in GitHub
3. In Which events would you like to trigger this webhook section, choose Let me select individual events and select the below events to trigger the Webhook. Next, click on Add webhook
  • Issues
  • Pushes
  • Pull Requests
  • Releases
  • Repository Vulnerability Alerts
Add the events for which your Webhook will get triggered
Note:
This integration supports the below GitHub events:
  • Issues (Supports auto-resolution)
  • Pushes
  • Pull Requests (Supports auto-resolution)
  • Releases
  • Repository Vulnerability Alerts (Supports auto-resolution)
That is it, you are good to go!
  • Every time an Issue, Push, Pull Request, or Release event occurs in GitHub, an incident would be created in Squadcast.
  • When an Issue or a Pull Request is closed in GitHub, the corresponding incident in Squadcast will be automatically resolved for it.
  • However, for Pushes and Releases, users will have to manually resolve the associated incidents in Squadcast.
Have any questions? Ask the community.