Confluence 5.3 has reached end of life
Check out the [latest version] of the documentation
People can view and manage in-app notifications and tasks in their Confluence workbox. This page tells you how to enable in-app notifications and configure some related settings.
In addition, people can receive notifications from JIRA and other Confluence servers in their Confluence workbox. To make this possible, your Confluence server must be linked to the other server(s) via application links.
Possible configurations:
- Your Confluence server provides in-app notifications and displays them in its own workbox. There are two sub-configurations here:
- This Confluence server is the only server involved.
- Alternatively, this Confluence server displays its own in-app notifications, and also displays notifications from JIRA and/or other Confluence servers.
- Your Confluence server does not provide or display in-app notifications.
Your Confluence server sends in-app notifications to another Confluence server.
Notes:
- Workbox includes notifications and tasks: When you enable in-app notifications, personal tasks are also enabled in the workbox. When you disable in-app notifications, the workbox no longer appears and personal tasks are therefore not available on this server.
Which notifications are included?
The workbox displays a notification when someone does one of the following in Confluence: The workbox does not show notifications triggered because you are watching a space. Only watches on pages and blog posts are relevant here. The notification in your workbox appears as 'read' if you have already viewed the page or blog post. If your Confluence site is linked to JIRA, you will also see the following JIRA notifications in your workbox:
Enabling Confluence workbox and in-app notifications
Confluence workbox and in-app notifications are disabled by default.
To enable workbox and in-app notifications:
- Choose the cog icon at top right of the screen, then choose Confluence Admin.
- Choose In-app Notifications in the left-hand panel.
- Choose displays in-app notifications (or displays in-app notifications from other servers). The workbox icon will appear in the Confluence top menu bar and will be visible to all users.
Screenshot: Simple configuration with Confluence workbox and in-app notifications enabled for this server only
Configuring the polling intervals
The polling intervals are used by the Confluence server that displays in-app notifications and tasks in its workbox.
Option | Description |
---|---|
Active polling interval | This is the number of seconds that Confluence will wait before checking (polling) for new notifications relevant to the page that the user is currently viewing. This setting applies to the page open in the browser tab that currently has focus. It does not matter whether the user has the workbox open or not. |
Inactive polling interval | This is the number of seconds that Confluence will wait before checking (polling) for new notifications relevant to all pages that are not currently in focus. These pages may be on the Confluence server that displays the workbox, or on other Confluence or JIRA servers that send their notifications to this server. This setting defines an upper limit. For inactive pages, Confluence starts with a polling interval equal to the active polling interval, then gradually increases the interval between polls until it reaches the limit defined here. |
Including notifications from JIRA
Confluence workbox can include notifications from your JIRA issue tracker. In Confluence OnDemand, you can do this if you have JIRA OnDemand too.
To include notifications from JIRA:
- Connect JIRA and Confluence via application links: (Not applicable to Confluence OnDemand.)
- Choose the cog icon at top right of the screen, then choose Confluence Admin.
- Choose Application Links in the left-hand panel.
- Set up the link as described in Adding an Application Link.
- If your JIRA server is linked to more than one Confluence server, make sure that the primary link is the Confluence server that will display the in-app notifications in its workbox. See the JIRA guide to making an application link the primary link.
- Choose In-app Notifications in the left-hand panel of the Confluence administration console.
- Choose displays in-app notifications from other servers.
- Your JIRA server will appear in the list of linked applications below this option.
- People will see JIRA notifications in their workbox, as described in Managing Notifications in Confluence.
Notes:
- JIRA sends its notifications to the Confluence server that is configured as the primary application link.
- Your JIRA server must be running JIRA 5.2 or later.
- The following plugins must be present and enabled in JIRA. The plugins are shipped with JIRA 5.2 and later:
- 'Workbox – Common Plugin'
- 'Workbox – JIRA Provider Plugin'
- You do not need to configure JIRA. The plugins are enabled by default in JIRA, and JIRA will automatically send notifications to Confluence.
- Confluence can display notifications from more than one server.
Screenshot: This Confluence server displays in-app notifications from itself and from JIRA
Stopping JIRA from sending notifications to Confluence
You may wish to configure Confluence to display its own notifications in its workbox, but prevent notifications from JIRA from appearing in the workbox, even when JIRA and Confluence are linked via application links.
The JIRA administration interface does not offer a way of disabling notifications sent to Confluence.
To stop JIRA from sending notifications to Confluence: Disable the following plugins in JIRA. (See the Universal Plugin Manager guide to disabling plugins.)
- 'Workbox – Common Plugin'
- 'Workbox – JIRA Provider Plugin'
Including notifications from another Confluence server
Confluence workbox can include notifications from another Confluence server. Not applicable to Confluence OnDemand.
Let's assume that you have two Confluence servers, ConfluenceChatty and ConfluenceQuiet. Let's also assume that you want ConfluenceChatty to display a workbox, and to include notifications from ConfluenceQuiet.
To include notifications from other Confluence servers:
- Connect ConfluenceChatty and ConfluenceQuiet via application links. In ConfluenceChatty:
- Choose the cog icon at top right of the screen, then choose Confluence Admin.
- Choose Application Links in the left-hand panel.
- Set up the link as described in Adding an Application Link.
- Configure the notification settings in ConfluenceChatty:
- Choose In-app Notifications in the left-hand panel of the Confluence administration console.
- Choose displays in-app notifications from other servers.
- Configure the notification settings in ConfluenceQuiet:
- Choose In-app Notifications in the left-hand panel of the Confluence administration console.
- Choose sends in-app notifications to another server.
- Select the Confluence server that will display the workbox – in our example, this is ConfluenceChatty. (The entry for ConfluenceChatty will appear here only if you have already configured ConfluenceChatty to display in-app notifications.)
Notes:
- Your Confluence servers must be running Confluence 4.3.3 or later.
- Confluence can display notifications from more than one server.
- Confluence can send notifications to only one server.
- Only one of the linked Confluence servers can display the in-app notifications.
Screenshot: This Confluence server displays in-app notifications from itself, from JIRA, and from another Confluence server
Sending Confluence notifications to another Confluence server
You can configure Confluence to send all notifications to a different Confluence server. In this case, the current Confluence server will not display the workbox.
To send notifications to another Confluence server: Follow the instructions in our example for ConfluenceQuiet above.
Screenshot: This Confluence server sends its in-app notifications to another Confluence server
Disabling workbox and in-app notifications in Confluence
If you choose does not provide in-app notifications:
- The Confluence workbox icon will no longer be visible and people will be unable to access their workboxes on this server.
- This Confluence server will no longer send notifications to its workbox, and will not send notifications to any other Confluence server.