Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the readme to include the new features #18

Closed
wants to merge 1 commit into from
Closed

Updated the readme to include the new features #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,17 @@ A Mattermost plugin for Confluence. Supports Confluence Cloud, Server, and Data
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.
- Notify a channel whenever something occurs on a Confluence object, we support the following events:
- space_updated
- page_created
- page_restored
- page_trashed
- page_updated
- comment_created
- comment_updated
- User can only create the subscriptions for the spaces and pages for which they have permissions to and the same for the notifications too.
- Admins can change permissions for both mattermost and confluence side from the plugin configuration.
![image](https://github.com/mattermost/mattermost-plugin-confluence/assets/90389917/f7e70d82-157b-4dc8-aa0a-868b115f2cb4)

## Configure notifications

Expand All @@ -46,9 +54,13 @@ With the Confluence plugin, you can subscribe to a variety of events in Confluen
![image](https://github.com/mattermost/mattermost-plugin-confluence/assets/74422101/9314abd2-8562-456e-9661-7f23c91db206)

- `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, inlcuidng those created, updated, deleted, restored, and those with added, deleted, or updated comments.

- space_updated
- page_created
- page_restored
- page_trashed
- page_updated
- comment_created
- comment_updated
Example of a configured notification:

![image](https://github.com/mattermost/mattermost-plugin-confluence/assets/74422101/33bc67f8-8d36-4e79-a386-7791f4dcd1ee)
Expand Down
Loading