Indexing triggers (webhooks) can be an extremely powerful tool that can be configured to activate an immediate re-index of your repositories from remote systems. Your git server can send this near real-time data to Jira when your git data changes. This results in a much faster indexing time where you don’t have to wait for the regular polling interval (see General settings).
Webhooks can be initiated whenever certain actions are performed. For example, you can configure a webhook to execute when:
a new commit is pushed
a pull request is opened
a branch is merged
You can create indexing triggers for individual repositories. Most git providers will also allow you to create webhooks at an account-level or org-level.
Do I need to set up indexing triggers?
By configuring indexing triggers to initiate reindexing, Jira will more often have up-to-date information.
Without setting up indexing triggers, you will be relying on the default polling of the app which is unchangeable by non-Jira administrators. Jira users will have to wait for the default interval for updates (usually 5 minutes) – which means users will not quickly see new commits or pull requests until the next indexing interval.
Important To use the indexing triggers feature, it must be enabled in the Manage (Git) repositories ➜ Indexing triggers page.
Configure indexing triggers to activate immediate reindex of your repositories from remote systems.
From your Jira dashboard menu, go to Apps ➜ Git Integration: View all repositories. (Alternatively, go to Jira Settings ➜ Apps).
On the sidebar, click Indexing triggers. The following screen is displayed.
Enable/disable the indexing trigger feature by clicking on the Indexing triggers enabled toggle switch.
Where to get the indexing triggers webhook URL?
The webhooks URL can be accessed on the following locations:
From your Jira dashboard menu, go to Apps ➜ Git Integration: View all repositories. On the sidebar, click Indexing triggers. (Alternatively, go to Jira Settings ➜ Apps. On the sidebar, click Indexing triggers).
On the Manage Git repositories configuration page, click the Indexing triggers button at the top right of the page.
In the Manage repository page of a tracked repository — click on a repository/integration from the git configuration list. Look for the Webhook URL field.
In the Repository Settings page of a repository in a tracked repository or a single connected repository — on the git configuration page, go to Actions ➜ Show integration repositories.
The Secret Key is a secure random-generated alphanumeric string at the time of the Git Integration for Jira app installation. The user can change this to a different value by generating another secret token according to your Git host.
For indexing to trigger, the repository URL that arrives in the webhook payload must match a repository that is in the Git Integration configuration account. However, it must also match within the webhook level.