diff --git a/client/options.go b/client/options.go
index 298a5332465d29baf3ca5e5ea3a3363056589e59..716528d7e51e3970e9e88798105b6c330b107c4c 100644
--- a/client/options.go
+++ b/client/options.go
@@ -45,6 +45,11 @@ func WithDelay(delay string) PublishOption {
return WithHeader("X-Delay", delay)
}
+// WithClick makes the notification action open the given URL as opposed to entering the detail view
+func WithClick(url string) PublishOption {
+ return WithHeader("X-Click", url)
+}
+
// WithEmail instructs the server to also send the message to the given e-mail address
func WithEmail(email string) PublishOption {
return WithHeader("X-Email", email)
diff --git a/cmd/publish.go b/cmd/publish.go
index 5817ccc220b1294f889cb8dd497e5153ec5c1c85..7c71a1b22c068d69dd38f9b7f45a3581d6508d46 100644
--- a/cmd/publish.go
+++ b/cmd/publish.go
@@ -20,6 +20,7 @@ var cmdPublish = &cli.Command{
&cli.StringFlag{Name: "priority", Aliases: []string{"p"}, Usage: "priority of the message (1=min, 2=low, 3=default, 4=high, 5=max)"},
&cli.StringFlag{Name: "tags", Aliases: []string{"tag", "T"}, Usage: "comma separated list of tags and emojis"},
&cli.StringFlag{Name: "delay", Aliases: []string{"at", "in", "D"}, Usage: "delay/schedule message"},
+ &cli.StringFlag{Name: "click", Aliases: []string{"U"}, Usage: "URL to open when notification is clicked"},
&cli.StringFlag{Name: "email", Aliases: []string{"e-mail", "mail", "e"}, Usage: "also send to e-mail address"},
&cli.BoolFlag{Name: "no-cache", Aliases: []string{"C"}, Usage: "do not cache message server-side"},
&cli.BoolFlag{Name: "no-firebase", Aliases: []string{"F"}, Usage: "do not forward message to Firebase"},
@@ -35,6 +36,7 @@ Examples:
ntfy pub --delay=10s delayed_topic Laterzz # Delay message by 10s
ntfy pub --at=8:30am delayed_topic Laterzz # Send message at 8:30am
ntfy pub -e phil@example.com alerts 'App is down!' # Also send email to phil@example.com
+ ntfy pub --click="https://reddit.com" redd 'New msg' # Opens Reddit when notification is clicked
ntfy trigger mywebhook # Sending without message, useful for webhooks
Please also check out the docs on publishing messages. Especially for the --tags and --delay options,
@@ -56,6 +58,7 @@ func execPublish(c *cli.Context) error {
priority := c.String("priority")
tags := c.String("tags")
delay := c.String("delay")
+ click := c.String("click")
email := c.String("email")
noCache := c.Bool("no-cache")
noFirebase := c.Bool("no-firebase")
@@ -78,6 +81,9 @@ func execPublish(c *cli.Context) error {
if delay != "" {
options = append(options, client.WithDelay(delay))
}
+ if click != "" {
+ options = append(options, client.WithClick(email))
+ }
if email != "" {
options = append(options, client.WithEmail(email))
}
diff --git a/docs/publish.md b/docs/publish.md
index ec017e050d4c1ece706a4ba3be4c6abe17b43127..844a849809b9b7b005e786c1955a8c240dac162f 100644
--- a/docs/publish.md
+++ b/docs/publish.md
@@ -592,6 +592,73 @@ Here's an example with a custom message, tags and a priority:
file_get_contents('https://ntfy.sh/mywebhook/publish?message=Webhook+triggered&priority=high&tags=warning,skull');
```
+## Click action
+You can define which URL to open when a notification is clicked. This may be useful if your notification is related
+to a Zabbix alert or a transaction that you'd like to provide the deep-link for. Tapping the notification will open
+the web browser (or the app) and open the website.
+
+Here's an example that will open Reddit when the notification is clicked:
+
+=== "Command line (curl)"
+ ```
+ curl \
+ -d "New messages on Reddit" \
+ -H "Click: https://www.reddit.com/message/messages" \
+ ntfy.sh/reddit_alerts
+ ```
+
+=== "ntfy CLI"
+ ```
+ ntfy publish \
+ --click="https://www.reddit.com/message/messages" \
+ reddit_alerts "New messages on Reddit"
+ ```
+
+=== "HTTP"
+ ``` http
+ POST /reddit_alerts HTTP/1.1
+ Host: ntfy.sh
+ Click: https://www.reddit.com/message/messages
+
+ New messages on Reddit
+ ```
+
+=== "JavaScript"
+ ``` javascript
+ fetch('https://ntfy.sh/reddit_alerts', {
+ method: 'POST',
+ body: 'New messages on Reddit',
+ headers: { 'Click': 'https://www.reddit.com/message/messages' }
+ })
+ ```
+
+=== "Go"
+ ``` go
+ req, _ := http.NewRequest("POST", "https://ntfy.sh/reddit_alerts", strings.NewReader("New messages on Reddit"))
+ req.Header.Set("Click", "https://www.reddit.com/message/messages")
+ http.DefaultClient.Do(req)
+ ```
+
+=== "Python"
+ ``` python
+ requests.post("https://ntfy.sh/reddit_alerts",
+ data="New messages on Reddit",
+ headers={ "Click": "https://www.reddit.com/message/messages" })
+ ```
+
+=== "PHP"
+ ``` php-inline
+ file_get_contents('https://ntfy.sh/reddit_alerts', false, stream_context_create([
+ 'http' => [
+ 'method' => 'POST',
+ 'header' =>
+ "Content-Type: text/plain\r\n" .
+ "Click: https://www.reddit.com/message/messages",
+ 'content' => 'New messages on Reddit'
+ ]
+ ]));
+ ```
+
## E-mail notifications
You can forward messages to e-mail by specifying an address in the header. This can be useful for messages that
you'd like to persist longer, or to blast-notify yourself on all possible channels.
@@ -883,6 +950,7 @@ and can be passed as **HTTP headers** or **query parameters in the URL**. They a
| `X-Priority` | `Priority`, `prio`, `p` | [Message priority](#message-priority) |
| `X-Tags` | `Tags`, `Tag`, `ta` | [Tags and emojis](#tags-emojis) |
| `X-Delay` | `Delay`, `X-At`, `At`, `X-In`, `In` | Timestamp or duration for [delayed delivery](#scheduled-delivery) |
+| `X-Click` | `Click` | URL to open when [notification is clicked](#click-action) |
| `X-Email` | `X-E-Mail`, `Email`, `E-Mail`, `mail`, `e` | E-mail address for [e-mail notifications](#e-mail-notifications) |
| `X-Cache` | `Cache` | Allows disabling [message caching](#message-caching) |
| `X-Firebase` | `Firebase` | Allows disabling [sending to Firebase](#disable-firebase) |