Webhooks
Updated
by Megan Storie
What is a Webhook?
Webhooks are a simple method that Jira uses to notify applications like ours about events like issue creation or new comments. Rather than relying on constant polling, webhooks provide a lightweight mechanism for remote applications to receive push notifications. For instance, changes in Jira bugs can be automatically pushed to a test management system, facilitating efficient retesting.
How Webhooks Work in Our Solution
Upon connecting with Jira through our solution, an automatic webhook is generated. It’s important that the main authorized user be a Jira admin because only admins have the privilege to create webhooks. Webhooks serve as the communication bridge between Jira and our system, enabling Jira to notify us when specific events occur.
Integration via API Calls
Our solution operates by utilizing API calls, which are a way for different systems to communicate with each other. For instance, if you create a ticket using our solution, it triggers an API call to initiate the process. In the event of changes or actions within Jira, the webhook is the mechanism through which Jira informs external systems, like Slack, ensuring that relevant notifications are promptly delivered.
Addressing Notification Issues
If users encounter issues with notifications not being received, it may be related to problems with the webhook. The webhook is responsible for facilitating the flow of information from Jira to external applications, aligning with the concept of "mechanisms for letting remote applications receive push notifications from Jira."
Does this app function with only a single webhook?
A single, global webhook is created during application setup. However, other features do rely on additional webhooks, like our JQL-based channel notifications setting. This creates a new webhook for each Slack channel that is configured to receive notifications based on a custom JQL query.
Do I need to be concerned about a large number of webhooks?
Most customers will never generate a number of webhooks that would cause any concern. For very large Slack & Jira environments, however, an excessive number of webhooks can be generated by users, leading to potential Jira performance issues. To address this issue, it’s possible to disable the creation of JQL-based Channel Notifications in our Dashboard. This will prevent users from configuring JQL-based notifications in Slack channels.
What if I receive duplicate notifications?
The app tries to avoid creating duplicate webhooks, but there are rare scenarios where this is possible. If you are receiving multiple notifications, you will often find that you have duplicate webhooks. Removing one of them can solve the issue. Feel free to reach out to our support team to help with this issue.
Where do I find Webhooks in Jira or Confluence?
Jira: https://JiraUrl/plugins/servlet/webhooks
Confluence: https://ConfluenceURL/plugins/servlet/webhooks
