Uploaded image for project: 'Jira Platform Cloud'
  1. Jira Platform Cloud
  2. JRACLOUD-78207

Webhooks adding multiple escape characters in text fields

      Issue Summary

      When using a webhook to get issue updates or creation the Description field is escaping characters such as '[' with multiple escapes and being returned as

      \\[
      

      This results in problems with API integrations where users get the value from webhooks to update issues.

      The problem is more explicitly using API v3 with the ADF format as when the description is updated with the escape character from the webhook it will also add more escape characters, for example:

      • Issue description is set to "test [.]"
      • Webhook sends it using two escapes
        test \\[.]
        
      • The value is used as-is to update a description using ADF
        {
          "version": 1,
          "type": "doc",
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "test \\[.]"
                }
              ]
            }
          ]
        }
        
      • The description of the issue is displayed as 
        test \[.] 
      • The webhook then returns the description as "test \\\\\\[.]" using multiple escapes on both the '\' and the '[' characters

      Steps to Reproduce

      1. Create a Webhook to fire upon issue creation/update
      2. Open an issue and edit its description with the example text test [.]

      Expected Results

      The JSON response from the webhook should have returned the description text as displayed in the issue test [.]

      Actual Results

      The JSON response sent is adding two escape characters returning

      test \\[.]
      

      Workaround

      Currently, there is no known workaround for this behavior. A workaround will be added here when available

          Form Name

            [JRACLOUD-78207] Webhooks adding multiple escape characters in text fields

            Atlassian Update - May 25, 2023

            Hi everyone,

            Thank you for previously raising this bug and bringing it to our attention.

            Within our company roadmap and work capacity, we try to address or review each bug request but admit that not each one will be resolved. To continue the culture of being honest and open, we are closing this bug to focus on our upcoming roadmap for all Jira users.

            As we continue to roll out features we do look at requests made by our users and if you feel like this bug is still impacting your team please let us know.

            Thank you again for providing valuable feedback to our team!
            Jira Cloud team

            Matthew Hunter added a comment - Atlassian Update - May 25, 2023 Hi everyone, Thank you for previously raising this bug and bringing it to our attention. Within our company roadmap and work capacity, we try to address or review each bug request but admit that not each one will be resolved. To continue the culture of being honest and open, we are closing this bug to focus on our upcoming roadmap for all Jira users. As we continue to roll out features we do look at requests made by our users and if you feel like this bug is still impacting your team please let us know. Thank you again for providing valuable feedback to our team! Jira Cloud team

              Unassigned Unassigned
              87999cee8e58 Alexandre Furtado
              Affected customers:
              1 This affects my team
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: