From f3a498d0bb49a68fcffaadb65afd6ccc2a06e6a3 Mon Sep 17 00:00:00 2001 From: Matthew Hodgson Date: Mon, 16 Feb 2015 22:09:10 +0000 Subject: [PATCH] document the concept of a standard `external_url` field for gatewayed events --- drafts/as-http-api.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/drafts/as-http-api.rst b/drafts/as-http-api.rst index d7b076c3..488bfe30 100644 --- a/drafts/as-http-api.rst +++ b/drafts/as-http-api.rst @@ -425,6 +425,15 @@ SHOULD be mapped in the same way as "user" URIs. alias: } +Event fields +~~~~~~~~~~~~ +We recommend that any gatewayed events should include an `external_url` field in +their content to provide a way for Matrix clients to link into the 'native' +client from which the event originated. For instance, this could contain the +message-ID for emails/nntp posts, or a link to a blog comment when gatewaying +blog comment traffic in & out of matrix + + Examples -------- .. NOTE::