• Products
  • Get started
  • Documentation
  • Resources

Integrate with GitHub

The feature described in this article is currently rolling out to some Jira Service Management Cloud customers. It may not yet be visible or available on your site.

GitHub Logo

What does the integration offer?

Use GitHub integration to forward events such as pull requests, issues, and push events to Jira Service Management with detailed information. Jira Service Management acts as a dispatcher for GitHub alerts, determines the right people to notify based on on-call schedules via email, text messages (SMS), phone calls, or iOS & 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 Jira Service Management.

  • When an issue is created in your GitHub repository, an alert is created in Jira Service Management.

  • When a push is made to your GitHub repository, an alert is created in Jira Service Management.

  • When a pull request is closed in your GitHub repository, the alert is closed in Jira Service Management.

  • When an issue is closed in your GitHub repository, the alert is closed in Jira Service Management.

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 Jira Service Management

  • Configure the integration in GitHub

Add a GitHub integration

If you're using the Free or Standard plan in Jira Service Management, you can only add this integration from your team’s operations page. To access the feature through Settings (gear icon) > Products (under JIRA SETTINGS) > OPERATIONS, you need to be on Premium or Enterprise plan.

Adding an integration from your team’s operations page makes your team the owner of the integration. This means Jira Service Management only assigns the alerts received through this integration to your team.

To add a GitHub integration in Jira Service Management, complete the following steps:

  1. Go to your team’s operations page.

  2. On the left navigation panel, select Integrations and then Add integration.

  3. Run a search and select “Github”.

  4. On the next screen, enter a name for the integration.

  5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

  6. Select Continue.
    The integration is saved at this point.

  7. 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.

  8. 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:

  1. In your GitHub repository, open the Settings tab at the top.

  2. Select Webhooks from the left pane.

  3. Select Add webhook.

  4. Paste your webhook URL copied from Jira Service Management into Payload URL.

  5. Select application/json for Content type.

  6. Select Let me select individual events for Which events would you like to trigger this webhook?.

  7. Select PushIssues, and Pull request from the list. Leave the Active checkbox checked.

  8. Select Add webhook.

When you save a Webhook configuration in GitHub, a test alert is created in Jira Service Management. Read more about GitHub Webhooks.

 

Additional Help