Confluence Cloud Developer

Confluence Cloud Developer

Last updatedJun 3, 2020

Rate this page:

Connect cookbook

This cookbook is an extension of the JavaScript API Cookbook, which provides snippets of code that can be used in the clients browser to get information from the product.

Getting Confluence spaces

This retrieves a list of spaces from Confluence, and may require paging through the results to see all spaces from your instance.

1
2
3
4
5
6
7
8
9
10
11
12
13
AP.request({
  url: '/rest/api/space',
  success: function(response) {
    // convert the string response to JSON
    response = JSON.parse(response);

    // dump out the response to the console
    console.log(response);
  },
  error: function() {
    console.log(arguments);
  }  
});

Getting specific spaces from Confluence

This snippet lets you request a specific Confluence space by space key. In this example, we use ds. This recipe also provides some high-level information about the space. If you're looking for more information about a space, you can find out about the content in the space in the next example, using /rest/api/space/{space.key}/content.

1
2
3
4
5
6
7
8
9
10
11
12
13
AP.request({
  url: '/rest/api/space/ds',
  success: function(response) {
    // convert the string response to JSON
    response = JSON.parse(response);

    // dump out the response to the console
    console.log(response);
  },
  error: function() {
    console.log(arguments);
  }   
});

Getting pages in a space

This recipe returns a collection for a given space identifier (like ds in the example below), containing objects like a blog post and one of the pages in the space. This returns a collection for the given space identifier (e.g. ds) that contains a object of blog posts and one of pages in the space. You can also directly access pages (/rest/api/space/ds/content/page) or blog posts (/rest/api/space/ds/content/blogpost) if you want to page though the contents. 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
var space
AP.request({
  url: '/rest/api/space/ds/content',
  success: function(response) {
    // convert the string response to JSON
    response = JSON.parse(response);

    // dump out the response to the console
    console.log(response);
  },
  error: function() {
    console.log(arguments);
  }    
});

Using multiple webhooks

To listen for more than one event type, add webhooks to the webhooks module of your app descriptor, and add a route handler for each.

Here is an example modules section showing two webhooks:

1
2
3
4
5
6
7
8
9
10
11
12
"modules": {
         "webhooks": [
            {
                "event": "page_viewed",
                "url": "/page_viewed"
            },
            {
                "event": "comment_created",
                "url": "/comment_created"
            }
        ]
    }

Here are some minimal route handlers to match:

1
2
3
4
5
6
7
8
9
app.post('/page_viewed', addon.authenticate(), function (req, res) {
            console.log("Account ID " + req.body.userAccountId + " viewed page '" + req.body.page.title + "' at URL '" + req.body.page.self + "'.");
        }
    );

    app.post('/comment_created', addon.authenticate(), function (req, res) {
            console.log("Comment created.");
        }
    );

Rate this page: