Compare commits

...

2 Commits

Author SHA1 Message Date
Marie PUPO JEAMMET 7bbbec21f2 fixup! 📝(documentation) document webhooks and matrix interop 2025-06-30 12:02:38 +02:00
Marie PUPO JEAMMET 3ac28e4b0d 📝(documentation) document webhooks and matrix interop
Briefly document matrix interop and webhooks basic requirements
2025-06-30 11:47:35 +02:00
2 changed files with 21 additions and 0 deletions
+14
View File
@@ -0,0 +1,14 @@
# Interoperability with Matrix API
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/).
## Purpose
With webhooks using this protocol, you can automate the invitation and removal of your colleagues' accounts to Matrix chat rooms.
> [!NOTE]
> 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 OIDC tokens.
## For devs
Client methods follow syntax from [Matrix Client-Server API v1.14]https://spec.matrix.org/v1.14/client-server-api/
+7
View File
@@ -0,0 +1,7 @@
# General considerations on webhooks
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.
## Requirements for webhook clients
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.