summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2018-05-23 13:55:39 +0100
committerRichard van der Hoff <richard@matrix.org>2018-05-23 13:55:39 +0100
commit052d08a6a579f4f9a98a76a3cb39c05d8d5aaa90 (patch)
tree5f6d8040602be5b652b7651c93352e2180389593 /docs
parentNotes on the manhole (diff)
downloadsynapse-052d08a6a579f4f9a98a76a3cb39c05d8d5aaa90.tar.xz
Using the manhole to send server notices
Diffstat (limited to 'docs')
-rw-r--r--docs/server_notices.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/server_notices.md b/docs/server_notices.md
index 22bca332d5..a96a5b88a3 100644
--- a/docs/server_notices.md
+++ b/docs/server_notices.md
@@ -51,3 +51,16 @@ The only compulsory setting is `system_mxid_localpart`, which defines the user
 id of the server notices user, as above. `system_mxid_display_name` and
 `room_name` define the displayname of the system notices user, and of
 the notices room, respectively.
+
+Sending notices
+---------------
+
+As of the current version of synapse, there is no convenient interface for
+sending notices (other than the automated ones sent as part of consent
+tracking).
+
+In the meantime, it is possible to test this feature using the manhole. Having gone into the manhole as described in [manhole.md](manhole.md), a notice can be sent with something like:
+
+```
+>>> hs.get_server_notices_manager().send_notice('@user:server.com', {'msgtype':'m.text', 'body':'foo'})
+```