What does the integration offer?
Use GitHub integration to forward events such as pull requests, issues, and push events to Compass with detailed information. Compass acts as a dispatcher for GitHub alerts, determines the right people to notify based on on-call schedules, notifies via email, text messages (SMS), phone calls and iOS and Android push notifications, and escalates alerts until they are acknowledged or closed.
How does the integration work?
With a default configuration, the following is how the integration works:
When a pull request is created in your GitHub repository, an alert is created in Compass.
When an issue is created in your GitHub repository, an alert is created in Compass.
When a push is made to your GitHub repository, an alert is created in Compass.
When a pull request is closed in your GitHub repository, the alert is closed in Compass.
When an issue is closed in your GitHub repository, the alert is closed in Compass.
You can define additional rules to suit your needs.
Set up the integration
GitHub is an API-based integration. Setting it up involves the following steps:
Add a GitHub integration in Compass
Configure the integration in GitHub
Add a GitHub integration
| Info |
|---|
In this release, only incoming integrations are fully supported in the Standard plan, at a team level. To use outgoing integrations or the outgoing part of bidirectional integrations, upgrade to a higher subscription plan. There may be restrictions on how you can create and apply integration rules as well. You can add this integration only from your team’s operations page. Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team. |
To add a GitHub integration in Compass, complete the following steps:
Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “Github”.
On the next screen, enter aname for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.Expand the Steps to configure the integration section and copy the webhook URL generated for your account.
You will use this URL while configuring the integration in GitHub later.Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.
Configure the integration in GitHub
To configure the integration in GitHub, complete the following steps:
In your GitHub repository, open the Settings tab at the top.
Select Webhooks from the left pane.
Select Add webhook.
Paste your webhook URL copied from Compass into Payload URL.
Select application/json for Content type.
Select Let me select individual events for Which events would you like to trigger this webhook?.
Select Push, Issues, and Pull request from the list. Leave the Active checkbox checked.
Select Add webhook.
When you save a Webhook configuration in GitHub, a test alert is created in Compass. Read more about GitHub Webhooks.