Uploaded image for project: 'Confluence Cloud'
  1. Confluence Cloud
  2. CONFCLOUD-36613

Allow Confluence Webhook Administration

    XMLWordPrintable

Details

    • 12
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      NOTE: This suggestion is for Confluence Cloud. Using Confluence Server? See the corresponding suggestion.

      Feature Request

      Currently JIRA offers a webhook administration page. We would like to see a similar feature in Confluence.

      Workaround

      WARNING!

      There is one security concern regarding webhooks created using the way explained below: even though they can only be created by admins, there are no other permissions checks. If a regular user creates a restricted page, admins won't be able to access it via Confluence UI/API, but they will be able to receive webhooks related to this page. The information of course is very limited, but they will be able to see a title of a page, for example. We fixed this for regular webhooks a couple of years ago, but here it's not possible since there is no user to check permissions against.

       

      There exists a private API that can be used for this purpose. However, the endpoint discussed below is intended for internal use only. Therefore, it is not part of the official Confluence Cloud REST APIs, it is not supported and it can change without any notice.

      Once this has been said: you can register, list or delete Webhooks in Confluence Cloud by using the internal REST API endpoint /wiki/rest/webhooks/1.0/webhook.

      The endpoint works the same way as the /rest/webhooks/1.0/webhook endpoint documented for Jira Cloud in the Webhook documentation page, section: Registering a webhook using the Jira REST API (Other integrations)

       

      To register a webhook using REST:

      1. Send a POST request using below format to: https://your-domain.atlassian.net/wiki/rest/webhooks/1.0/webhook
        {
          "name": "Webhook (test comment created)",
          "url": "https://www.example.com/webhooks",
          "events": [
            "comment_created"
          ]
        } 
      1. The response will return the webhook in JSON with additional information, including the user that created the webhook, the created timestamp, etc.

      For a complete list of events, etc, please refer to the Confluence Cloud Webhook documentation page.

       

      To unregister (that is, delete) a webhook using REST:

      Example:
      The following would delete the webhook with an ID of 70:

      curl --user EmailAddress:ApiToken -X DELETE -H "Content-Type: application/json" https://your-domain.atlassian.net/wiki/rest/webhooks/1.0/webhook/70
      

       

      To query a webhook using REST:

      Example:

      curl --user EmailAddress:ApiToken -X GET -H "Content-Type: application/json" https://your-domain.atlassian.net/rest/webhooks/1.0/webhook
      

       

      Example: the following would get a webhook with an ID of 72

      curl --user EmailAddress:ApiToken -X GET -H "Content-Type: application/json" https://your-domain.atlassian.net/rest/webhooks/1.0/webhook/72
      

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              namir Nursihah Amir (Inactive)
              Votes:
              134 Vote for this issue
              Watchers:
              87 Start watching this issue

              Dates

                Created:
                Updated: