Skip to content

Commit 3ac28e4

Browse files
committed
📝(documentation) document webhooks and matrix interop
Briefly document matrix interop and webhooks basic requirements
1 parent 10dcdfc commit 3ac28e4

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/interoperability/matrix.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Interoperability with Matrix API
2+
3+
Matrix is a protocol for secure, decentralized communication. It's the protocol used by [Tchap](https://www.tchap.gouv.fr/), another application of [La Suite](https://lasuite.numerique.gouv.fr/).
4+
5+
## Purpose
6+
7+
With webhooks using this protocol, you can automate the invitation and removal of your colleagues' accounts to Matrix chat rooms.
8+
9+
> [!NOTE]
10+
> The first version of this feature requires inviting a bot and giving it moderation permission to your Matrix room. This won't be necessary in future versions of the feature, as invitations/removal will be made in your name using your [ProConnect](https://www.proconnect.gouv.fr/) account.

docs/interoperability/webhooks.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# General considerations on webhooks
2+
3+
Webhooks are small add-ons you can link to your teams to automate the sending of information from People to other apps. Configure your webhooks to point to the tools or ressources you want to share with your group (such as a chatroom, a kanban board or a specific collection in your knowledge base). Whenever you add (or remove) someone from your team in People, access will also be granted (or revoked) to your resources.
4+
5+
## Requirements for webhook clients
6+
7+
Your webhook client must contain "invite_user_to_group" and "remove_user_from_group" methods, describing how to connect to your ressource and to grant and revoke accesses.

0 commit comments

Comments
 (0)