From 706dd3b1cae6ab5a5ed8353dd887d63915b24761 Mon Sep 17 00:00:00 2001 From: ayusht2810 Date: Mon, 12 Feb 2024 14:06:42 +0530 Subject: [PATCH] Updated the readme --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 717afba..39f6deb 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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)