diff --git a/api/client-server/v1/pusher.yaml b/api/client-server/v1/pusher.yaml index 99a70ee7..8c243f2b 100644 --- a/api/client-server/v1/pusher.yaml +++ b/api/client-server/v1/pusher.yaml @@ -22,7 +22,7 @@ paths: post: summary: Modify a pusher for this user on the homeserver. description: |- - This endpoint allows the creation, modification and deletion of pushers + This endpoint allows the creation, modification and deletion of `pushers`_ for this user ID. The behaviour of this endpoint varies depending on the values in the JSON body. security: diff --git a/specification/modules/push.rst b/specification/modules/push.rst index 7948475c..6e9c8536 100644 --- a/specification/modules/push.rst +++ b/specification/modules/push.rst @@ -64,6 +64,8 @@ Push Gateway devices or GCM for Android devices. Clients inform the homeserver which Push Gateway to send notifications to when it sets up a Pusher. +.. _def:pushers: + Pusher A pusher is a worker on the homeserver that manages the sending of HTTP notifications for a user. A user can have multiple pushers: one per @@ -89,6 +91,8 @@ There is a single API endpoint for this, as described below. {{pusher_http_api}} +.. _pushers: `def:pushers`_ + Push Rules ~~~~~~~~~~ A push rule is a single rule that states under what *conditions* an event should