wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #1628 from turt2live/travis/as/external_url

Browse source 
Clarify how external_url is supposed to work
This commit is contained in:
Travis Ralston 2018-08-30 11:12:39 -06:00 • committed by GitHub
commit 70f72b5b3b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

21
specification/application_service_api.rst
View file

@ -417,11 +417,18 @@ additional parameters on the ``/publicRooms`` client-server endpoint.
{{appservice_room_directory_cs_http_api}} {{appservice_room_directory_cs_http_api}}
Event fields Referencing messages from a third party network
~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We recommend that any events that originated from a remote network should Application services should include an ``external_url`` in the ``content`` of
include an ``external_url`` field in their content to provide a way for Matrix events it emits to indicate where the message came from. This typically applies
clients to link into the 'native' client from which the event originated. to application services that bridge other networks into Matrix, such as IRC,
For instance, this could contain the message-ID for emails/nntp posts, or a link where an HTTP URL may be available to reference.
to a blog comment when bridging blog comment traffic in & out of Matrix.
Clients should provide users with a way to access the ``external_url`` if it
is present. Clients should additionally ensure the URL has a scheme of ``https``
or ``http`` before making use of it.
The presence of an ``external_url`` on an event does not necessarily mean the
event was sent from an application service. Clients should be wary of the URL
contained within, as it may not be a legitimate reference to the event's source.