Subscribe from your phone
++ Simply get the app and start publishing messages. To learn more about the app, + check out the documentation. +
+
+ 
+ 
+ 
+
Subscribe in this Web UI
@@ -118,59 +135,42 @@Subscribe from your phone
+Subscribe using the API
- You can use the Ntfy Android App - to receive notifications directly on your phone. Just like the server, this app is also open source. - Since I don't have an iPhone or a Mac, I didn't make an iOS app yet. I'd be awesome if someone else could help out. + There's a super simple API that you can use to integrate your own app. You can consume + a JSON stream, + an SSE/EventSource stream (useful for web apps), + as well as a plain text stream.
-
-
-
-
Subscribe via your app, or via the CLI
- Using EventSource in JS, you can consume - notifications like this (see live example): -
-
- const eventSource = new EventSource('https://ntfy.sh/mytopic/sse');
- eventSource.onmessage = (e) => {
- // Do something with e.data
- };
-
- - You can also use the same /sse endpoint via curl or any other HTTP library: -
-
- $ curl -s ntfy.sh/mytopic/sse
- event: open
- data: {"id":"weSj9RtNkj","time":1635528898,"event":"open","topic":"mytopic"}
-
- data: {"id":"p0M5y6gcCY","time":1635528909,"event":"message","topic":"mytopic","message":"Hi!"}
-
- event: keepalive
- data: {"id":"VNxNIg5fpt","time":1635528928,"event":"keepalive","topic":"test"}
-
- - To consume JSON instead, use the /json endpoint, which prints one message per line: + Here's an example for JSON. Note that the connection stays open, so you can retrieve messages as they come in:
$ curl -s ntfy.sh/mytopic/json
{"id":"SLiKI64DOt","time":1635528757,"event":"open","topic":"mytopic"}
{"id":"hwQ2YpKdmg","time":1635528741,"event":"message","topic":"mytopic","message":"Hi!"}
- {"id":"DGUDShMCsc","time":1635528787,"event":"keepalive","topic":"mytopic"}
+ {"id":"DGUDShMCsc","time":1635528787,"event":"keepalive","topic":"mytopic"}
+ ...
- - Or use the /raw endpoint if you need something super simple (empty lines are keepalive messages): + +
+ +
+ +More, more, more!
++ ntfy has so many more features and you can learn about all of them in the documentation + (I tried my very best to make it the best docs ever 😉, not sure if I succeeded, hehe). +
+ +
+
+ Forever free, forever 100% free software
++ I love free software, and I'm doing this because it's fun. I have no bad intentions, and I will + never monetize or sell your information. This service will always stay free and open. You can + read more in the FAQs and in the privacy policy.
-
- $ curl -s ntfy.sh/mytopic/raw
-
- This is a notification
- And another one with a smiley face 😀
-