feat(webhook): add customizable HTTP method, query params, and payload template

ItsAzni · ItsAzni · commit 3de88ba7c471 · 2026-04-26T12:07:23.000+07:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -33,6 +33,9 @@ jobs:
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
 
+      - name: Clean build
+        run: ./gradlew clean
+
       - name: Decode Keystore
         run: |
           echo "${{ secrets.KEYSTORE_BASE64 }}" | base64 --decode > ${{ github.workspace }}/notif-forwarder-release.jks
@@ -45,6 +48,10 @@ jobs:
             -Pandroid.injected.signing.key.alias=${{ secrets.KEY_ALIAS }} \
             -Pandroid.injected.signing.key.password=${{ secrets.KEY_PASSWORD }}
 
+      - name: Cleanup Keystore
+        if: always()
+        run: rm -f ${{ github.workspace }}/notif-forwarder-release.jks
+
       - name: Rename APK
         run: |
           if [[ "${{ github.ref }}" == refs/tags/* ]]; then
@@ -86,3 +93,6 @@ jobs:
           prerelease: false
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+permissions:
+  contents: write
diff --git a/README.md b/README.md
@@ -5,7 +5,8 @@ Android app to listen for incoming notifications and forward them to a configura
 ## Features
 
 - Notification capture using `NotificationListenerService`
-- Webhook forwarding with configurable URL, auth mode, and custom headers
+- Webhook forwarding with configurable URL, HTTP method, auth mode, custom headers, query params, and payload template
+- Compatible with Telegram Bot API, Discord webhooks, and any custom API
 - Queue system with Room (durable local storage)
 - Retry system with WorkManager (network constraints + backoff)
 - Background support
@@ -24,6 +25,63 @@ Android app to listen for incoming notifications and forward them to a configura
 ./gradlew assembleDebug
 ```
 
+## Webhook Configuration
+
+### Supported HTTP Methods
+- `GET` — no request body, query params appended to URL
+- `POST` — with JSON body
+- `PUT` — with JSON body
+- `PATCH` — with JSON body
+
+### Authentication
+- **None** — no auth header
+- **Bearer** — adds `Authorization: Bearer <token>`
+- **Custom** — define any headers manually
+
+### Custom Query Params
+Add per line as `key=value`:
+```
+chat_id=123456789
+token=abc123
+```
+
+### Custom Payload Template
+Use JSON with variable placeholders. Leave blank for default payload.
+
+Available variables:
+- `{deviceId}`
+- `{packageName}`
+- `{appName}`
+- `{title}`
+- `{text}`
+- `{postedAt}`
+- `{notificationKey}`
+
+#### Example: Telegram Bot API
+- URL: `https://api.telegram.org/bot<token>/sendMessage`
+- Method: `POST`
+- Payload template:
+```json
+{"chat_id":"123456789","text":"*{appName}*\n*{title}*\n{text}","parse_mode":"Markdown"}
+```
+
+#### Example: Discord Webhook
+- URL: `https://discord.com/api/webhooks/.../...`
+- Method: `POST`
+- Payload template:
+```json
+{"content":"**{appName}**\n**{title}**\n{text}"}
+```
+
+#### Example: Custom GET API
+- URL: `https://example.com/api/alert`
+- Method: `GET`
+- Query params:
+```
+device={deviceId}
+msg={title}
+```
+
 ## Local Webhook API (`webhook/`)
 
 This repository includes a Node.js webhook receiver in `webhook/` for local testing.
@@ -52,12 +110,14 @@ Health check:
 
 Environment config (`webhook/.env`):
 
-- `HOST`
-- `PORT`
-- `WEBHOOK_PATH`
-- `WEBHOOK_BEARER_TOKEN`
-- `WEBHOOK_LOG_FILE`
-- `JSON_LIMIT`
+| Key | Description |
+|-----|-------------|
+| `HOST` | Server host |
+| `PORT` | Server port |
+| `WEBHOOK_PATH` | Webhook endpoint path |
+| `WEBHOOK_BEARER_TOKEN` | Optional bearer token |
+| `WEBHOOK_LOG_FILE` | Log file path |
+| `JSON_LIMIT` | Max JSON body size |
 
 ## Screenshots
 
@@ -71,6 +131,12 @@ Environment config (`webhook/.env`):
 <img src="screenshots/filter.jpg" alt="Filter" width="240" />
 <img src="screenshots/queue.jpg" alt="Queue" width="240" />
 
+## Build
+
+```bash
+./gradlew clean assembleDebug
+```
+
 ## License
 
 This project is licensed under the MIT License.
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -13,7 +13,7 @@ android {
         minSdk = 26
         targetSdk = 36
         versionCode = 1
-        versionName = "1.0"
+        versionName = "1.1.0"
 
         testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
     }
diff --git a/app/src/main/java/com/itsazni/notificationforwarder/MainActivity.kt b/app/src/main/java/com/itsazni/notificationforwarder/MainActivity.kt
@@ -83,25 +83,31 @@ private enum class AppTab(val label: String, val icon: ImageVector) {
 
 private data class UiSettings(
     val webhookUrl: String,
+    val webhookMethod: String,
     val forwardingEnabled: Boolean,
     val filterMode: FilterMode,
     val filterPackagesRaw: String,
     val authMode: AuthMode,
     val bearerToken: String,
     val customHeadersRaw: String,
+    val queryParamsRaw: String,
+    val payloadTemplateRaw: String,
     val maxRetriesRaw: String,
     val batchSizeRaw: String
 )
 
 private fun AppSettings.toUiSettings(): UiSettings {
     return UiSettings(
         webhookUrl = webhookUrl,
+        webhookMethod = webhookMethod,
         forwardingEnabled = forwardingEnabled,
         filterMode = filterMode,
         filterPackagesRaw = filterPackages.joinToString("\n"),
         authMode = authMode,
         bearerToken = bearerToken,
         customHeadersRaw = customHeadersRaw,
+        queryParamsRaw = queryParamsRaw,
+        payloadTemplateRaw = payloadTemplateRaw,
         maxRetriesRaw = maxRetries.toString(),
         batchSizeRaw = batchSize.toString()
     )
@@ -179,12 +185,14 @@ private fun MainScreen(settingsStore: SettingsStore) {
                         val result = withContext(Dispatchers.IO) {
                             WebhookClient().send(
                                 url = uiSettings.webhookUrl,
-                                method = "POST",
+                                method = uiSettings.webhookMethod,
                                 headers = buildHeadersPreview(
                                     authMode = uiSettings.authMode,
                                     token = uiSettings.bearerToken,
                                     customHeadersRaw = uiSettings.customHeadersRaw
                                 ),
+                                queryParams = parseKeyValuePairs(uiSettings.queryParamsRaw),
+                                payloadTemplate = uiSettings.payloadTemplateRaw,
                                 item = QueueItem(
                                     packageName = "com.test.package",
                                     appName = "Webhook Test",
@@ -383,6 +391,15 @@ private fun WebhookScreen(
                         singleLine = true
                     )
 
+                    DropdownSelector(
+                        label = "HTTP method",
+                        value = uiSettings.webhookMethod,
+                        options = listOf("GET", "POST", "PUT", "PATCH"),
+                        onSelected = {
+                            onSettingsChange(uiSettings.copy(webhookMethod = it))
+                        }
+                    )
+
                     DropdownSelector(
                         label = "Auth mode",
                         value = uiSettings.authMode.name,
@@ -410,6 +427,24 @@ private fun WebhookScreen(
                         label = { Text("Custom headers (Key: Value per line)") }
                     )
 
+                    OutlinedTextField(
+                        modifier = Modifier
+                            .fillMaxWidth()
+                            .height(140.dp),
+                        value = uiSettings.queryParamsRaw,
+                        onValueChange = { onSettingsChange(uiSettings.copy(queryParamsRaw = it)) },
+                        label = { Text("Query params (key=value per line)") }
+                    )
+
+                    OutlinedTextField(
+                        modifier = Modifier
+                            .fillMaxWidth()
+                            .height(200.dp),
+                        value = uiSettings.payloadTemplateRaw,
+                        onValueChange = { onSettingsChange(uiSettings.copy(payloadTemplateRaw = it)) },
+                        label = { Text("Payload template (JSON with {title} {text} etc.)") }
+                    )
+
                     Button(modifier = Modifier.fillMaxWidth(), onClick = onSave) {
                         Text("Save Webhook Settings")
                     }
@@ -639,12 +674,15 @@ private fun QueueStatCard(
 
 private fun saveSettings(settingsStore: SettingsStore, uiSettings: UiSettings) {
     settingsStore.webhookUrl = uiSettings.webhookUrl
+    settingsStore.webhookMethod = uiSettings.webhookMethod
     settingsStore.forwardingEnabled = uiSettings.forwardingEnabled
     settingsStore.filterMode = uiSettings.filterMode
     settingsStore.filterPackages = SettingsStore.parsePackages(uiSettings.filterPackagesRaw)
     settingsStore.authMode = uiSettings.authMode
     settingsStore.bearerToken = uiSettings.bearerToken
     settingsStore.customHeadersRaw = uiSettings.customHeadersRaw
+    settingsStore.queryParamsRaw = uiSettings.queryParamsRaw
+    settingsStore.payloadTemplateRaw = uiSettings.payloadTemplateRaw
     settingsStore.maxRetries = uiSettings.maxRetriesRaw.toIntOrNull() ?: 10
     settingsStore.batchSize = uiSettings.batchSizeRaw.toIntOrNull() ?: 20
 }
@@ -658,6 +696,21 @@ private fun isNotificationListenerEnabled(context: Context): Boolean {
     return enabled.contains(target.flattenToString())
 }
 
+private fun parseKeyValuePairs(raw: String): Map<String, String> {
+    val map = linkedMapOf<String, String>()
+    raw.lines().forEach { line ->
+        val trimmed = line.trim()
+        if (trimmed.isEmpty()) return@forEach
+        val idx = trimmed.indexOf('=')
+        if (idx > 0) {
+            val key = trimmed.substring(0, idx).trim()
+            val value = trimmed.substring(idx + 1).trim()
+            if (key.isNotEmpty()) map[key] = value
+        }
+    }
+    return map
+}
+
 private fun buildHeadersPreview(
     authMode: AuthMode,
     token: String,
diff --git a/app/src/main/java/com/itsazni/notificationforwarder/network/WebhookClient.kt b/app/src/main/java/com/itsazni/notificationforwarder/network/WebhookClient.kt
@@ -1,7 +1,9 @@
 package com.itsazni.notificationforwarder.network
 
 import com.google.gson.Gson
+import com.google.gson.JsonParser
 import com.itsazni.notificationforwarder.data.QueueItem
+import okhttp3.HttpUrl.Companion.toHttpUrlOrNull
 import okhttp3.MediaType.Companion.toMediaType
 import okhttp3.OkHttpClient
 import okhttp3.Request
@@ -30,23 +32,49 @@ class WebhookClient {
         url: String,
         method: String,
         headers: Map<String, String>,
+        queryParams: Map<String, String>,
+        payloadTemplate: String,
         item: QueueItem,
         deviceId: String
     ): SendResult {
         return try {
-            val payload = mapOf(
+            val vars = mapOf(
                 "deviceId" to deviceId,
-                "packageName" to item.packageName,
-                "appName" to item.appName,
-                "title" to item.title,
-                "text" to item.text,
-                "postedAt" to item.postedAt,
-                "notificationKey" to item.notificationKey
+                "packageName" to escapeJson(item.packageName),
+                "appName" to escapeJson(item.appName),
+                "title" to escapeJson(item.title),
+                "text" to escapeJson(item.text),
+                "postedAt" to item.postedAt.toString(),
+                "notificationKey" to escapeJson(item.notificationKey)
             )
-            val bodyJson = gson.toJson(payload)
+
+            val finalUrl = buildUrl(url, queryParams)
+            val bodyJson = if (payloadTemplate.isBlank()) {
+                gson.toJson(
+                    mapOf(
+                        "deviceId" to deviceId,
+                        "packageName" to item.packageName,
+                        "appName" to item.appName,
+                        "title" to item.title,
+                        "text" to item.text,
+                        "postedAt" to item.postedAt,
+                        "notificationKey" to item.notificationKey
+                    )
+                )
+            } else {
+                renderTemplate(payloadTemplate, vars)
+            }
+
+            val isGet = method.equals("GET", ignoreCase = true)
             val requestBuilder = Request.Builder()
-                .url(url)
-                .method(method, bodyJson.toRequestBody("application/json".toMediaType()))
+                .url(finalUrl)
+
+            if (isGet) {
+                requestBuilder.get()
+            } else {
+                val contentType = headers["Content-Type"] ?: "application/json"
+                requestBuilder.method(method.uppercase(), bodyJson.toRequestBody(contentType.toMediaType()))
+            }
 
             headers.forEach { (k, v) ->
                 requestBuilder.addHeader(k, v)
@@ -64,4 +92,32 @@ class WebhookClient {
             SendResult(false, false, e.message ?: "network error")
         }
     }
+
+    private fun buildUrl(baseUrl: String, params: Map<String, String>): String {
+        if (params.isEmpty()) return baseUrl
+        val httpUrl = baseUrl.toHttpUrlOrNull() ?: return baseUrl
+        val builder = httpUrl.newBuilder()
+        params.forEach { (k, v) -> builder.addQueryParameter(k, v) }
+        return builder.build().toString()
+    }
+
+    private fun renderTemplate(template: String, vars: Map<String, String>): String {
+        var result = template
+        vars.forEach { (k, v) ->
+            result = result.replace("{$k}", v)
+        }
+        // validate JSON to catch syntax errors early
+        JsonParser.parseString(result)
+        return result
+    }
+
+    private fun escapeJson(text: String): String {
+        return text
+            .replace("\\", "\\\\")
+            .replace("\"", "\\\"")
+            .replace("\b", "\\b")
+            .replace("\n", "\\n")
+            .replace("\r", "\\r")
+            .replace("\t", "\\t")
+    }
 }
diff --git a/app/src/main/java/com/itsazni/notificationforwarder/settings/SettingsStore.kt b/app/src/main/java/com/itsazni/notificationforwarder/settings/SettingsStore.kt
diff --git a/app/src/main/java/com/itsazni/notificationforwarder/worker/QueueWorker.kt b/app/src/main/java/com/itsazni/notificationforwarder/worker/QueueWorker.kt

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ android {`
`13`	`13`	`minSdk = 26`
`14`	`14`	`targetSdk = 36`
`15`	`15`	`versionCode = 1`
`16`		`- versionName = "1.0"`
	`16`	`+ versionName = "1.1.0"`
`17`	`17`
`18`	`18`	`testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"`
`19`	`19`	`}`