Get watches for page

GET /wiki/rest/api/content/{id}/notification/child-created

Returns the watches for a page. A user that watches a page will receive receive notifications when the page is updated.

If you want to manage watches for a page, use the following user methods:

• Get content watch status for user
• Add content watch
• Remove content watch

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Connect app scope required: READ

Request

Example

1
2
3
4
5
6
7
8
9
10
11
12

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/notification/child-created`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

Get watches for space

GET /wiki/rest/api/content/{id}/notification/created

Returns all space watches for the space that the content is in. A user that watches a space will receive receive notifications when any content in the space is updated.

If you want to manage watches for a space, use the following user methods:

• Get space watch status for user
• Add space watch
• Remove space watch

Permissions required: Permission to access the Confluence site ('Can use' global permission).

Connect app scope required: READ

Request

Example

1
2
3
4
5
6
7
8
9
10
11
12

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/content/{id}/notification/created`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

Get space watchers

GET /wiki/rest/api/space/{spaceKey}/watch

Returns a list of watchers of a space

Connect app scope required: READ

Request

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/confluence/rest/#auth
import api, { route } from "@forge/api";

const response = await api.requestConfluence(route`/wiki/rest/api/space/{spaceKey}/watch`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

Get content watch status

GET /wiki/rest/api/user/watch/content/{contentId}

Returns whether a user is watching a piece of content. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: READ

Request

Example

1
2
3
4
5
6
7
8
9
10
11
12

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/content/{contentId}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

Add content watcher

POST /wiki/rest/api/user/watch/content/{contentId}

Adds a user as a watcher to a piece of content. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: WRITE

Request

Example

1
2
3
4
5
6
7
8
9
10

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/content/{contentId}`, {
  method: 'POST'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

Remove content watcher

DELETE /wiki/rest/api/user/watch/content/{contentId}

Removes a user as a watcher from a piece of content. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: DELETE

Request

Example

1
2
3
4
5
6
7
8
9
10

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/content/{contentId}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

Get label watch status

GET /wiki/rest/api/user/watch/label/{labelName}

Returns whether a user is watching a label. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: READ

Request

Example

1
2
3
4
5
6
7
8
9
10
11
12

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/label/{labelName}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

Add label watcher

POST /wiki/rest/api/user/watch/label/{labelName}

Adds a user as a watcher to a label. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: WRITE

Request

Example

1
2
3
4
5
6
7
8
9
10

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/label/{labelName}`, {
  method: 'POST'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

Remove label watcher

DELETE /wiki/rest/api/user/watch/label/{labelName}

Removes a user as a watcher from a label. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: DELETE

Request

Example

1
2
3
4
5
6
7
8
9
10

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/label/{labelName}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

Get space watch status

GET /wiki/rest/api/user/watch/space/{spaceKey}

Returns whether a user is watching a space. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: READ

Request

Example

1
2
3
4
5
6
7
8
9
10
11
12

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/space/{spaceKey}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

Add space watcher

POST /wiki/rest/api/user/watch/space/{spaceKey}

Adds a user as a watcher to a space. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Note, you must add the X-Atlassian-Token: no-check header when making a request, as this operation has XSRF protection.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: WRITE

Request

Example

1
2
3
4
5
6
7
8
9
10

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/space/{spaceKey}`, {
  method: 'POST'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

Remove space watch

DELETE /wiki/rest/api/user/watch/space/{spaceKey}

Removes a user as a watcher from a space. Choose the user by doing one of the following:

• Specify a user via a query parameter: Use the accountId to identify the user.
• Do not specify a user: The currently logged-in user will be used.

Permissions required: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

Connect app scope required: DELETE

Request

Example

1
2
3
4
5
6
7
8
9
10

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/user/watch/space/{spaceKey}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses