|
|
|
@ -30,22 +30,37 @@ irrespective of the underlying homeserver implementation.
|
|
|
|
.. contents:: Table of Contents
|
|
|
|
.. contents:: Table of Contents
|
|
|
|
.. sectnum::
|
|
|
|
.. sectnum::
|
|
|
|
|
|
|
|
|
|
|
|
Specification version
|
|
|
|
Changelog
|
|
|
|
---------------------
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. topic:: Version: unstable
|
|
|
|
|
|
|
|
{{application_service_changelog}}
|
|
|
|
|
|
|
|
|
|
|
|
This version of the specification is generated from
|
|
|
|
This version of the specification is generated from
|
|
|
|
`matrix-doc <https://github.com/matrix-org/matrix-doc>`_ as of Git commit
|
|
|
|
`matrix-doc <https://github.com/matrix-org/matrix-doc>`_ as of Git commit
|
|
|
|
`{{git_version}} <https://github.com/matrix-org/matrix-doc/tree/{{git_rev}}>`_.
|
|
|
|
`{{git_version}} <https://github.com/matrix-org/matrix-doc/tree/{{git_rev}}>`_.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
For the full historical changelog, see
|
|
|
|
|
|
|
|
https://github.com/matrix-org/matrix-doc/blob/master/changelogs/application_service.rst
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Other versions of this specification
|
|
|
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The following other versions are also available, in reverse chronological order:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
- `HEAD <https://matrix.org/docs/spec/application_service/unstable.html>`_: Includes all changes since the latest versioned release.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Application Services
|
|
|
|
Application Services
|
|
|
|
--------------------
|
|
|
|
--------------------
|
|
|
|
Application services are passive and can only observe events from a given
|
|
|
|
Application services are passive and can only observe events from homeserver.
|
|
|
|
homeserver (HS). They can inject events into rooms they are participating in.
|
|
|
|
They can inject events into rooms they are participating in.
|
|
|
|
They cannot prevent events from being sent, nor can they modify the content of
|
|
|
|
They cannot prevent events from being sent, nor can they modify the content of
|
|
|
|
the event being sent. In order to observe events from a homeserver, the
|
|
|
|
the event being sent. In order to observe events from a homeserver, the
|
|
|
|
homeserver needs to be configured to pass certain types of traffic to the
|
|
|
|
homeserver needs to be configured to pass certain types of traffic to the
|
|
|
|
application service. This is achieved by manually configuring the homeserver
|
|
|
|
application service. This is achieved by manually configuring the homeserver
|
|
|
|
with information about the application service (AS).
|
|
|
|
with information about the application service.
|
|
|
|
|
|
|
|
|
|
|
|
Registration
|
|
|
|
Registration
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
@ -169,6 +184,34 @@ An example registration file for an IRC-bridging application service is below:
|
|
|
|
Homeserver -> Application Service API
|
|
|
|
Homeserver -> Application Service API
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legacy routes
|
|
|
|
|
|
|
|
+++++++++++++
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Previous drafts of the application service specification had a mix of endpoints
|
|
|
|
|
|
|
|
that have been used in the wild for a significant amount of time. The application
|
|
|
|
|
|
|
|
service specification now defines a version on all endpoints to be more compatible
|
|
|
|
|
|
|
|
with the rest of the Matrix specification and the future.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Homeservers should attempt to use the specified endpoints first when communicating
|
|
|
|
|
|
|
|
with application services. However, if the application service receives an http status
|
|
|
|
|
|
|
|
code that does not indicate success (ie: 404, 500, 501, etc) then the homeserver
|
|
|
|
|
|
|
|
should fall back to the older endpoints for the application service.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The older endpoints have the exact same request body and response format, they
|
|
|
|
|
|
|
|
just belong at a different path. The equivalent path for each is as follows:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
* ``/_matrix/app/v1/transactions/{txnId}`` becomes ``/transactions/{txnId}``
|
|
|
|
|
|
|
|
* ``/_matrix/app/v1/users/{userId}`` becomes ``/users/{userId}``
|
|
|
|
|
|
|
|
* ``/_matrix/app/v1/rooms/{roomAlias}`` becomes ``/rooms/{roomAlias}``
|
|
|
|
|
|
|
|
* ``/_matrix/app/v1/thirdparty/protocol/{protocol}`` becomes ``/_matrix/app/unstable/thirdparty/protocol/{protocol}``
|
|
|
|
|
|
|
|
* ``/_matrix/app/v1/thirdparty/user/{user}`` becomes ``/_matrix/app/unstable/thirdparty/user/{user}``
|
|
|
|
|
|
|
|
* ``/_matrix/app/v1/thirdparty/location/{location}`` becomes ``/_matrix/app/unstable/thirdparty/location/{location}``
|
|
|
|
|
|
|
|
* ``/_matrix/app/v1/thirdparty/user`` becomes ``/_matrix/app/unstable/thirdparty/user``
|
|
|
|
|
|
|
|
* ``/_matrix/app/v1/thirdparty/location`` becomes ``/_matrix/app/unstable/thirdparty/location``
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Homeservers should periodically try again for the newer endpoints because the
|
|
|
|
|
|
|
|
application service may have been updated.
|
|
|
|
|
|
|
|
|
|
|
|
Pushing events
|
|
|
|
Pushing events
|
|
|
|
++++++++++++++
|
|
|
|
++++++++++++++
|
|
|
|
|
|
|
|
|
|
|
|
@ -179,24 +222,24 @@ events. Each list of events includes a transaction ID, which works as follows:
|
|
|
|
|
|
|
|
|
|
|
|
Typical
|
|
|
|
Typical
|
|
|
|
HS ---> AS : Homeserver sends events with transaction ID T.
|
|
|
|
HS ---> AS : Homeserver sends events with transaction ID T.
|
|
|
|
<--- : AS sends back 200 OK.
|
|
|
|
<--- : Application Service sends back 200 OK.
|
|
|
|
|
|
|
|
|
|
|
|
AS ACK Lost
|
|
|
|
AS ACK Lost
|
|
|
|
HS ---> AS : Homeserver sends events with transaction ID T.
|
|
|
|
HS ---> AS : Homeserver sends events with transaction ID T.
|
|
|
|
<-/- : AS 200 OK is lost.
|
|
|
|
<-/- : AS 200 OK is lost.
|
|
|
|
HS ---> AS : Homeserver retries with the same transaction ID of T.
|
|
|
|
HS ---> AS : Homeserver retries with the same transaction ID of T.
|
|
|
|
<--- : AS sends back 200 OK. If the AS had processed these events
|
|
|
|
<--- : Application Service sends back 200 OK. If the AS had processed these
|
|
|
|
already, it can NO-OP this request (and it knows if it is the same
|
|
|
|
events already, it can NO-OP this request (and it knows if it is the
|
|
|
|
events based on the transaction ID).
|
|
|
|
same events based on the transaction ID).
|
|
|
|
|
|
|
|
|
|
|
|
The events sent to the application service should be linearised, as if they were
|
|
|
|
The events sent to the application service should be linearised, as if they were
|
|
|
|
from the event stream. The homeserver MUST maintain a queue of transactions to
|
|
|
|
from the event stream. The homeserver MUST maintain a queue of transactions to
|
|
|
|
send to the AS. If the application service cannot be reached, the homeserver
|
|
|
|
send to the application service. If the application service cannot be reached, the
|
|
|
|
SHOULD backoff exponentially until the application service is reachable again.
|
|
|
|
homeserver SHOULD backoff exponentially until the application service is reachable again.
|
|
|
|
As application services cannot *modify* the events in any way, these requests can
|
|
|
|
As application services cannot *modify* the events in any way, these requests can
|
|
|
|
be made without blocking other aspects of the homeserver. Homeservers MUST NOT
|
|
|
|
be made without blocking other aspects of the homeserver. Homeservers MUST NOT
|
|
|
|
alter (e.g. add more) events they were going to send within that transaction ID
|
|
|
|
alter (e.g. add more) events they were going to send within that transaction ID
|
|
|
|
on retries, as the AS may have already processed the events.
|
|
|
|
on retries, as the application service may have already processed the events.
|
|
|
|
|
|
|
|
|
|
|
|
{{transactions_as_http_api}}
|
|
|
|
{{transactions_as_http_api}}
|
|
|
|
|
|
|
|
|
|
|
|
@ -337,7 +380,7 @@ users needs API changes in order to:
|
|
|
|
- Have a 'passwordless' user.
|
|
|
|
- Have a 'passwordless' user.
|
|
|
|
|
|
|
|
|
|
|
|
This involves bypassing the registration flows entirely. This is achieved by
|
|
|
|
This involves bypassing the registration flows entirely. This is achieved by
|
|
|
|
including the AS token on a ``/register`` request, along with a login type of
|
|
|
|
including the ``as_token`` on a ``/register`` request, along with a login type of
|
|
|
|
``m.login.application_service`` to set the desired user ID without a password.
|
|
|
|
``m.login.application_service`` to set the desired user ID without a password.
|
|
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
::
|
|
|
|
@ -374,13 +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
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Application services should include an ``external_url`` in the ``content`` of
|
|
|
|
|
|
|
|
events it emits to indicate where the message came from. This typically applies
|
|
|
|
|
|
|
|
to application services that bridge other networks into Matrix, such as IRC,
|
|
|
|
|
|
|
|
where an HTTP URL may be available to reference.
|
|
|
|
|
|
|
|
|
|
|
|
.. TODO-TravisR: Fix this section to be a general "3rd party networks" section
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
We recommend that any events that originated from a remote network should
|
|
|
|
The presence of an ``external_url`` on an event does not necessarily mean the
|
|
|
|
include an ``external_url`` field in their content to provide a way for Matrix
|
|
|
|
event was sent from an application service. Clients should be wary of the URL
|
|
|
|
clients to link into the 'native' client from which the event originated.
|
|
|
|
contained within, as it may not be a legitimate reference to the event's source.
|
|
|
|
For instance, this could contain the message-ID for emails/nntp posts, or a link
|
|
|
|
|
|
|
|
to a blog comment when bridging blog comment traffic in & out of Matrix.
|
|
|
|
|
|
|
|
|
Travis Ralston
6 years ago