docs/application_services.rst


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

Registering an Application Service
==================================

The registration of new application services depends on the homeserver used. 
In synapse, you need to create a new configuration file for your AS and add it
to the list specified under the ``app_service_config_files`` config
option in your synapse config.

For example:

.. code-block:: yaml

  app_service_config_files:
  - /home/matrix/.synapse/<your-AS>.yaml


The format of the AS configuration file is as follows:

..  code-block:: yaml

    url: <base url of AS>
    as_token: <token AS will add to requests to HS>
    hs_token: <token HS will add to requests to AS>
    sender_localpart: <localpart of AS user>
    namespaces:
      users:  # List of users we're interested in
        - exclusive: <bool>
          regex: <regex>
        - ...
      aliases: []  # List of aliases we're interested in
      rooms: [] # List of room ids we're interested in

See the spec_ for further details on how application services work.

.. _spec: https://github.com/matrix-org/matrix-doc/blob/master/specification/25_application_service_api.rst#application-service-api