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

Documentation about how to include a JQL filter when Registering a webhook via the JIRA REST API is incorrect

XMLWordPrintable

      On the following documentation, the JSON example mentions that a JQL filter can be included when registering a webhook via the JIRA REST API (under the Registering a webhook via the JIRA REST API section):

      {
        "name": "my first webhook via rest",
        "url": "http://www.example.com/webhooks",
        "events": [
          "jira:issue_created",
          "jira:issue_updated"
        ],
        "jqlFilter": "Project = JRA AND resolution = Fixed",
        "excludeIssueDetails" : false
      }
      

      The webhook is created by using the call above, but without the JQL filter. The correct way to register the JQL filter when creating a Webhook is:

      {
        "name": "my first webhook via rest",
        "url": "http://www.example.com/webhooks",
        "events": [
          "jira:issue_created",
          "jira:issue_updated"
        ],
      "filters": {
              "issue-related-events-section": "JRA AND resolution = Fixed"},
        "excludeIssueDetails" : false
      }
      

              bszturemska@atlassian.com Beata Szturemska
              rdasilva@atlassian.com Renan da Silva (Inactive)
              Votes:
              2 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: