Uploaded image for project: 'Jira Service Management Data Center'
  1. Jira Service Management Data Center
  2. JSDSERVER-10771

Improve the Service Management automation documentation to mention the whitelisting of webhook

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • None
    • Documentation & IX
    • None
    • 0
    • We collect Jira Service Desk feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

    Description

      Issue

      Due to security concern, from JSM 4.6.0, the automation module was updated in a way that it will only send a webhook to an URL if this URL has been whitelisted, as per this developer community discussion. For this reason, whenever a new automation rule is configured to sent a webhook, it is necessary to whitelist the webhook URL in the page ⚙ > System > Whitelist for the automation to send the webhook. Otherwise, the automation will not be executed.

      Another issue is that the JSM automation rule always shows a SUCCESS in the logs regardless if the webhook was sent or not (due to the whitelisting). This is a bug tracked in https://jira.atlassian.com/browse/JSDSERVER-6955.

      The problem is that our official documentation about JSM automation does not say anything about whitelisting the webhook URLs for JSM automation rules to work.

      On top of it, there is nothing in the JSM automation UI that tells users that they have to whitelist the webhook URL at the time they are creating the automation rule.

      Ideally, we should update both the UI (by adding a warning to the user configuring the automation rule), and we should update the documentation, so that users can refer to it.

      Related KB article: Webhooks are not sent from Jira Service Management Automation rules

      Suggestion

      Update the section Customize automation webhooks of the documentation https://confluence.atlassian.com/servicemanagementserver/automating-your-service-project-939926334.html by mentioning that from JSM 4.6.0, any webhook URL needs to be whitelisted in ⚙ > System > Whitelist for the webhook to be sent.

      Attachments

        Issue Links

          Activity

            People

              tbartyzel Tomasz Bartyzel
              jrey Julien Rey
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:

                Backbone Issue Sync