diff options
Diffstat (limited to 'docs/developer/server/push-notifications.md')
| -rw-r--r-- | docs/developer/server/push-notifications.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/developer/server/push-notifications.md b/docs/developer/server/push-notifications.md new file mode 100644 index 0000000..2207fb9 --- /dev/null +++ b/docs/developer/server/push-notifications.md @@ -0,0 +1,24 @@ +# Push Notifications + +Endpoints for web-push are kept in the table `subscription`, along with keys +necessary for signing messages sent to those endpoints. + +The server is responsible for processing events and determining, on a +user-by-user basis, whether they warrant triggering a web-push event. + +As the logic around what _can_ trigger a push evolves, we will keep this +documentation up to date. + +## Events that can trigger push + +- A new channel is created +- A new message arrives in a channel +- A new message containing your username arrives in a channel +- A new message containing a keyword you have configured arrives in a channel +- A message you wrote is stitched +- A message you have flagged is stitched + +## Current Configuration options + +The web client currently supports setting all of these options, but the server +does not store or honour these settings. |