As an Admin, the webhooks UI does not clearly show which variables I can use within a URL

XMLWordPrintable

    • Type: Suggestion
    • Resolution: Unresolved
    • None
    • Component/s: Webhooks
    • None
    • 3

      Problem Definition

      When using the webhooks UI to create or edit webhooks, some variables will be allowed to be used in the URL.

      However, not all event types provide the same URL variables; and it's not entirely clear which event types provide certain URL variables.

      Suggested Solution

      Provide a clearer way in the UI for an administrator to see which variables are provided by which event type.

      Why this is important

      Administrators may create webhooks with multiple events to make management easier - but if an event fires (that does not provide the variable) then the webhook will not behave as expected.

      Workaround

      You can insert the following CSS into Jira's Announcement Banner - it will make the "All variables are available" and "Some variables are available" states clearer so Administrators can at least see the difference.

      <style type="text/css">
      .webhooks .variable-intersection { font-weight: bold; color: #36B37E !important; }
      .webhooks .variable-some { font-weight: bold; color: #FFAB00 !important; }
      </style>
      

      Please ensure you test this change in a test environment first, before applying to production. If you see unusual behaviour in pages after applying this fix, you may need to remove the adjustments - we also have steps to remove the announcement banner through the database.

      Without the workaround
      No workaround, all variables available:

      No workaround, some variables available:

      With the workaround:
      Workaround, all variables available:

      Workaround, some variables available:

        1. no-workaround-all-available.png
          72 kB
          Dave Norton
        2. no-workaround-some-available.png
          71 kB
          Dave Norton
        3. workaround-all-available.png
          73 kB
          Dave Norton
        4. workaround-some-available.png
          70 kB
          Dave Norton

            Assignee:
            Unassigned
            Reporter:
            Dave Norton
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: