From c2d6e0e31632f3fc5a0d6fe5611140557f42b540 Mon Sep 17 00:00:00 2001 From: wunter8 Date: Wed, 15 Nov 2023 09:31:34 -0700 Subject: [PATCH] Include link to websocket example in docs --- docs/subscribe/api.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/subscribe/api.md b/docs/subscribe/api.md index 58da9752..3f1c0e81 100644 --- a/docs/subscribe/api.md +++ b/docs/subscribe/api.md @@ -190,9 +190,10 @@ format. Keepalive messages are sent as empty lines. ## WebSockets You may also subscribe to topics via [WebSockets](https://en.wikipedia.org/wiki/WebSocket), which is also widely -supported in many languages. Most notably, WebSockets are natively supported in JavaScript. On the command line, -I recommend [websocat](https://github.com/vi/websocat), a fantastic tool similar to `socat` or `curl`, but specifically -for WebSockets. +supported in many languages. Most notably, WebSockets are natively supported in JavaScript. You may also want to +check out the [full example on GitHub](https://github.com/binwiederhier/ntfy/tree/main/examples/web-example-websocket). +On the command line, I recommend [websocat](https://github.com/vi/websocat), a fantastic tool similar to `socat` +or `curl`, but specifically for WebSockets. The WebSockets endpoint is available at `/ws` and returns messages as JSON objects similar to the [JSON stream endpoint](#subscribe-as-json-stream).