https://github.com/mattermost/mattermost-plugin-confluence
A Mattermost Plugin to receive events from Confluence
https://github.com/mattermost/mattermost-plugin-confluence
hacktoberfest mattermost mattermost-plugin
Last synced: 4 months ago
JSON representation
A Mattermost Plugin to receive events from Confluence
- Host: GitHub
- URL: https://github.com/mattermost/mattermost-plugin-confluence
- Owner: mattermost
- License: apache-2.0
- Created: 2020-01-10T17:22:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-19T12:16:10.000Z (5 months ago)
- Last Synced: 2026-01-19T19:09:00.604Z (4 months ago)
- Topics: hacktoberfest, mattermost, mattermost-plugin
- Language: Go
- Homepage:
- Size: 1.49 MB
- Stars: 21
- Watchers: 24
- Forks: 17
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Contents
- [Overview](#overview)
- [Features](#features)
- [Admin Guide](/docs/admin-guide.md)
- Contribute
- [Development](#development)
- [License](/LICENSE)
# Mattermost Plugin for Confluence
[](https://circleci.com/gh/mattermost/mattermost-plugin-confluence)
[](https://codecov.io/gh/mattermost/mattermost-plugin-confluence)
[](https://github.com/mattermost/mattermost-plugin-confluence/releases/latest)
[](https://github.com/mattermost/mattermost-plugin-confluence/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Up+For+Grabs%22+label%3A%22Help+Wanted%22)
## Overview
A Mattermost plugin for Confluence. Supports Confluence Cloud, Server, and Data Center versions. This plugin helps your teams collaborate and keep in sync as Confluence Pages and Spaces get updated. Comments and activity can be pushed into specific Mattermost channels for full visibility.
## Features
With the Confluence plugin, you can subscribe to a variety of events in Confluence, and specify which channels the associated notifications will appear in.
- In a Mattermost channel, setup subscriptions to get updates from Confluence and manage your notification subscriptions directly within Mattermost.
- Notify a channel whenever something occurs on a Confluence object:
- Confluence spaces, including those created, updated, deleted, and restored, and those with added comments.
- Confluence pages, including those created, updated, deleted, restored, and those with added, deleted, or updated comments.
**Note**: For Confluence server version greater than 9:
- users need to be connected to Mattermost in order to get the Confluence notifications, or the admin has to setup an API token.
- users will not be notified for destructive events such as when content is purged. However, users will be notified when content is non-permanently deleted (sent to trash).
- users migrating from Confluence plugin versions earlier than `v1.4.0` to `v1.4.0` or later can remove the jar file from Confluence instance and set up OAuth and webhook to complete the plugin configuration as provided by the slash command `/confluence install`.
## Configure notifications
- The ``Alias`` (Subscription Name) is intended to be an easy to remember name for the subscription. You will use this name when you need to edit the configuration again.
- `Confluence Base URL` is the URL of the Confluence server this rule is intended to come from. The Confluence server must have been setup by an administrator with Mattermost using the `/confluence install` command prior to using it in a subscription.
- `Subscribe To` is used to specify if they want to follow events for a Page or a Space object.
- `Space Key` is the Confluence space key used for the project, often it is 2-4 characters, such as "PROJ" or "MM" and is unique for each Space on that Confluence server.
- `Page ID` is the ID of the Page object on Confuence. Since a page name can be changed by users, the underlying PageID is used to ensure tracking continues even if the page is renamed. The pageID of a Confluence page can be found by going to the "..." menu on the page, then selecting **Page Info**. The URL will then show the PageID in the URL at the end.
- `Events` are the internal confluence events that will trigger a notification from Confluence. The following events are currently included:
- Confluence spaces, including those created, updated, deleted, and restored, and those with added comments.
- Confluence pages, including those created, updated, deleted, restored, and those with added, deleted, or updated comments.
Example of a configured notification:
### /confluence subscribe
Show a list of all the subscriptions set for the current channel. When you need to see what subscription rules are setup for a channel, you can run `/confluence list` to see a list of the configured subscriptions.
### /confluence edit
Edit existing subscription settings. To change the subscription settings, you need to pass over the subscription name to edit. If you have spaces in your subscription names, you need to wrap them in quotation marks.
For example: `/confluence edit "Project A Subscription"`
To display a list of all the subscription names in the channel, type /confluence list then use the subscription names to edit the correct rule.
### /confluence unsubscribe
Stop receiving notifications to a channel. To stop receiving notifications to a channel, use the `unsubscribe` command to specify the subscription that should be unsubscribed.
example: `/confluence unsubscribe "Project A Subscription"`.
## Development
This plugin contains both a server and web app portion. Read our documentation about the [Developer Workflow](https://developers.mattermost.com/integrate/plugins/developer-workflow/) and [Developer Setup](https://developers.mattermost.com/integrate/plugins/developer-setup/) for more information about developing and extending plugins.
## Note for Confluence server versions greater or equal to 9
- For Confluence server version greater than or equal to 9, run `/confluence install server` and follow the setup instructions
- User who triggers the event on Confluence must be connected to Mattermost in order to get the notification
- Generic notifications will be received for Page subscriptions if the user who triggers the event on Confluence is not connected to Mattermost
- Administrators can setup an Admin API Token in the plugin configuration to allow notifications for events even when the user who triggers the event on Confluence is not connected to Mattermost
### / confluence connect
Connect your Mattermost account to Confluence.
### / confluence disconnect
Disconnect your Mattermost account to Confluence.
### Releasing new versions
The version of a plugin is determined at compile time, automatically populating a `version` field in the [plugin manifest](plugin.json):
* If the current commit matches a tag, the version will match after stripping any leading `v`, e.g. `1.3.1`.
* Otherwise, the version will combine the nearest tag with `git rev-parse --short HEAD`, e.g. `1.3.1+d06e53e1`.
* If there is no version tag, an empty version will be combined with the short hash, e.g. `0.0.0+76081421`.
To disable this behaviour, manually populate and maintain the `version` field.