Webhook Configuration Best Practices

Still need help?

The Atlassian Community is here for you.

Ask the community

Platform Notice: Server and Data Center Only. This article only applies to Atlassian products on the server and data center platforms.

Problem

Misconfiguration of Webhook could cause notifications and updates not being received on a third party application such as Stride.

Recommendations

  1. Create a specific JQL query to narrow the scope of Webhook configuration in order to include a specific project, component, label or fix version.
  2. Uncheck any event that is not required especially if you don't have Exclude body feature checked.

    Webhook includes all JSON data of an issue including histories. The Webhook payload will grow exponentially large when you have an issue with large number of comments. Imagine if you constantly updating an issue with 40,000 comments in history and you have configured Webhook on issue update event, you will trigger at least ~40MB worth of body data in the Webhook payload. And when the Webhook is constantly being triggered, this could lead to thread pool and network bandwidth exhaustion.



  3. Check Exclude body feature if you do not need the JSON of the body.

    Currently, it does not allow users to choose the required data to be included in the JSON body.

When your Webhook is not working?

If you notice that your Webhook is not working as expected e.g. Stride is not receiving notifications/updates from Jira on certain actions. Please refer to this KB article and get support from Atlassian: How to collect data to troubleshoot Webhook failure in Jira

Relevant Bugs and Improvements


Last modified on Jun 20, 2018

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.