For more information on Webhook indexing:

With the Webhook indexing integration, there is no need to enable indexing triggers in the git manager configuration page.

For a step-by-step setup guide, watch the following demonstration videos:

Video Guides

Repository Level

Right click here and open this video in a new window/tab for more viewing options.

Organization Level

Right click here and open this video in a new window/tab for more viewing options.

Connect GitHub.com or GitHub Enterprise Server using the Webhook Indexing integration type to Jira Cloud:

The steps outlined below requires that Git Integration for Jira app is already installed on your Jira Cloud instance. Otherwise, install the Git Integration for Jira app first from the Atlassian Marketplace.

  1. (blue star) Webhook indexing integration

    1. On your Jira Cloud dashboard, go to AppsGit Integration: Manage Git repositories.

    2. On the integration panel under Limited feature connect, click Webhooks.

    3. On the following screen, click GitHub as your git server type.

    4. Click Connect GitHub under Webhooks indexing column to connect to your git server. The following screen is displayed:

    5. Enter a meaningful Display name for the new webhook indexing integration.

    6. (blue star) Before clicking Finish, make sure to configure webhook for your git service. Follow the steps below for repository level or organization level webhook setup.

  2. (blue star) Repository Level (see full video walkthrough on this page)
    Open a new browser tab and login to your GitHub web portal to setup webhook triggers for the selected repository. Configure a webhook on your git service by performing the following steps:

    1. On your GitHub web portal, open a repository to work on.

    2. Go to (blue star) Settings.

    3. On the sidebar, click Webhooks.

    4. Click Add webhook. The next screen is displayed.

    5. On the Payload URL box, paste the Webhook URL that you got from the previous section.

    6. Select application/json as the Content type.

    7. On the Secret box, paste the Secret key that you got from step 4 above.

    8. Set or select which events to trigger for this webhook:

      • Just the push event – This will send trigger events for commits and branches only.

      • Send me everything – This will send triggers for every event the git service supports. However, this may impact Jira performance. (Not recommended)

      • Let me select individual events – This will send trigger events based on the specified selected events to track. We highly suggest to only select Pushes and Pull requests event triggers. (Recommended)

    9. Review your settings then click Add webhook to save the webhook configuration.

    10. The webhook configuration is added to the webhooks list.

  3. (blue star) Organization Level (see full video walkthrough on this page)
    Open a new browser tab and login to your GitHub web portal to configure webhook triggers for your selected organization. Configure a webhook on your git service by performing the following steps:

    1. On your GitHub web portal, open an organization to work on.

    2. Go to (blue star) Settings. The following screen is displayed.

    3. On the sidebar, click Webhooks.

    4. Click Add webhook. The next screen is displayed.

    5. On the Payload URL box, paste the Webhook URL that you got from the previous section.

    6. Select application/json as the Content type.

    7. On the Secret box, paste the Secret key that you got from step 4 above.

    8. Set or select which events to trigger for this webhook:

      • Just the push event – This will send trigger events for commits and branches only.

      • Send me everything – This will send triggers for every event the git service supports. However, this may impact Jira performance. (Not recommended)

      • Let me select individual events – This will send trigger events based on the specified selected events to track. We highly suggest to only select Pushes and Pull requests event triggers. (Recommended)

    9. Review your settings then click Add webhook to save the webhook configuration.

    10. The webhook configuration is added to the webhooks list.

  4. After you’re done setting up the webhook with your git service (GitHub), switch to the Jira Cloud browser tab. Click Finish to complete this setup.

With organization level webhook settings, all repositories within the org will be able to send webhook triggers as configured.

note

If you see any issues with the newly added webhook, verify that the Payload URL, Secret key and Content type are set properly. Edit the these settings and try again.

If you see any issues with the newly added webhook, verify that the Payload URL, Secret key and Content type are set properly. Edit the these settings and try again.

Edit integration settings via Actions on the Manage Git repository page. In here, you will find Webhook URL and Secret key for use with webhook setup with your git service.

How to link commits, branches and pull requests to a Jira issue?

Make a git commit if you don’t see any commits in the Git Commits tab of an associated Jira issue.

For information on this topic, see Linking git commits, associating branches and pull requests to a Jira issue.

Limited features for GitHub webhook indexing integration

The feature table displays the supported git features for the selected git server. For more information, see Feature matrix for Git Integration for Jira Cloud.

(info) Click View supported types below the table to see the currently supported git service types.

Webhook indexing supported git types

(tick) Works with git servers behind firewall

The webhooks indexing integration limits the features available. However, networks hosting git do not need to be updated to allow incoming requests as long as outbound requests can be made. See Webhook Indexing explainer for more information.

(tick) View commits, branches, pull requests in Jira

Commits, branches, pull requests are visible in the (blue star) Jira Development Information panel as well as in the (blue star) Git Commits issue tab and (blue star) Git Integration side panel of the Jira issue. Jira administrators can regulate access to these displays using the View development tools permission.

(blue star) View tags in Jira

(tick) Support for Automation for Jira + Smart Commits

Automation for Jira - the following triggers are supported:

  1. Commit created

  2. Branch created

  3. Pull request created

  4. Pull request declined

  5. Pull request merged

Smart Commits: Atlassian’s Smart Commits are enabled by default. Additional Smart Commit commands are available. See Smart Commits for more information.

(tick) Repository Browser

The Repository Browser allows users to view commits in git repositories by branch1. Users can manually link and unlink commits to Jira issues2.

(error) Create branches and pull requests in Jira

This feature is not supported with webhook indexing integration. For more information, see Feature matrix of Git Integration for Jira Cloud

(tick) Support for large number of commits in git pushes

Git servers may truncate how much of the activity is captured in a webhook on large git push events resulting in some git activity. For more information, see Feature matrix of Git Integration for Jira Cloud.

(error) Indexing full repository history

Webhook indexing integration will only show new commit/branch/pull request activity once webhooks are configured on the git server according to this wizard. For more information, see Feature matrix of Git Integration for Jira Cloud.

(error) View source code in Jira

Webhook indexing integration does not have this option as webhooks do not contain source code.

Other supported webhook indexing integration articles