Mention notifying AS for sender_localpart events

Signed-off-by: Matthias Ahouansou <matthias@ahouansou.cz>
matrix-org · Apr 27, 2024 · 48e6b30 · 48e6b30
1 parent 7201042
commit 48e6b30
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/changelogs/application_service/newsfragments/1810.clarification b/changelogs/application_service/newsfragments/1810.clarification
@@ -0,0 +1 @@
+Clarify that appservices should be notified of events relating to the sender_localpart user.
diff --git a/data/api/application-service/definitions/registration.yaml b/data/api/application-service/definitions/registration.yaml
@@ -29,7 +29,9 @@ properties:
     description: A secret token that the homeserver will use authenticate requests to the application service.
   sender_localpart:
     type: string
-    description: The localpart of the user associated with the application service.
+    description: |-
+      The localpart of the user associated with the application service. Events will be sent to the AS if this user is the target of the event, or
+      is a joined member of the room where the event occurred.
   namespaces:
     type: object
     title: Namespaces
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarify that appservices should be notified of events relating to the sender_localpart user.