Forked from
Maunium / synapse
4451 commits behind the upstream repository.
-
Andrew Morgan authored
Our documentation has a history of using a document's name as a way to link to it, such as "See [workers.md]() for details". This makes sense when you're traversing a directory of files, but less sense when the files are abstracted away - as they are on the documentation website. This PR changes the links to various documentation pages to something that fits better into the surrounding sentence, as you would when making any hyperlink on the web.
Andrew Morgan authoredOur documentation has a history of using a document's name as a way to link to it, such as "See [workers.md]() for details". This makes sense when you're traversing a directory of files, but less sense when the files are abstracted away - as they are on the documentation website. This PR changes the links to various documentation pages to something that fits better into the surrounding sentence, as you would when making any hyperlink on the web.
server_notices.md 1.10 KiB
Server Notices
The API to send notices is as follows:
POST /_synapse/admin/v1/send_server_noticeor:
PUT /_synapse/admin/v1/send_server_notice/{txnId}You will need to authenticate with an access token for an admin user.
When using the PUT form, retransmissions with the same transaction ID will be
ignored in the same way as with PUT /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}.
The request body should look something like the following:
{
"user_id": "@target_user:server_name",
"content": {
"msgtype": "m.text",
"body": "This is my message"
}
}You can optionally include the following additional parameters:
-
type: the type of event. Defaults tom.room.message. -
state_key: Setting this will result in a state event being sent.
Once the notice has been sent, the API will return the following response:
{
"event_id": "<event_id>"
}Note that server notices must be enabled in homeserver.yaml before this API
can be used. See the server notices documentation for more information.