Add support for Whapi notification provider (#4323)

Co-authored-by: Frank Elsinga <[email protected]>

server/notification-providers/whapi.js

@@ -0,0 +1,39 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+
+class Whapi extends NotificationProvider {
+    name = "whapi";
+
+    /**
+     * @inheritdoc
+     */
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        const okMsg = "Sent Successfully.";
+
+        try {
+            const config = {
+                headers: {
+                    "Accept": "application/json",
+                    "Content-Type": "application/json",
+                    "Authorization": "Bearer " + notification.whapiAuthToken,
+                }
+            };
+
+            let data = {
+                "to": notification.whapiRecipient,
+                "body": msg,
+            };
+
+            let url = (notification.whapiApiUrl || "https://gate.whapi.cloud/").replace(/\/+$/, "") + "/messages/text";
+
+            await axios.post(url, data, config);
+
+            return okMsg;
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+
+}
+
+module.exports = Whapi;

server/notification.js

@@ -56,6 +56,7 @@ const GoAlert = require("./notification-providers/goalert");
 const SMSManager = require("./notification-providers/smsmanager");
 const ServerChan = require("./notification-providers/serverchan");
 const ZohoCliq = require("./notification-providers/zoho-cliq");
+const Whapi = require("./notification-providers/whapi");
 const GtxMessaging = require("./notification-providers/gtx-messaging");
 const Cellsynt = require("./notification-providers/cellsynt");
 
@@ -131,6 +132,7 @@ class Notification {
             new WeCom(),
             new GoAlert(),
             new ZohoCliq(),
+            new Whapi(),
             new GtxMessaging(),
             new Cellsynt(),
         ];

src/components/NotificationDialog.vue

@@ -154,8 +154,9 @@ export default {
                 "webhook": "Webhook",
                 "GoAlert": "GoAlert",
                 "ZohoCliq": "ZohoCliq",
+                "whapi": "WhatsApp (Whapi)",
                 "gtxmessaging": "GtxMessaging",
-                "Cellsynt": "Cellsynt"
+                "Cellsynt": "Cellsynt",
             };
 
             // Put notifications here if it's not supported in most regions or its documentation is not in English

src/components/notifications/Whapi.vue

@@ -0,0 +1,33 @@
+<template>
+    <div class="mb-3">
+        <label for="whapi-api-url" class="form-label">{{ $t("API URL") }}</label>
+        <input id="whapi-api-url" v-model="$parent.notification.whapiApiUrl" placeholder="https://gate.whapi.cloud/" type="text" class="form-control">
+    </div>
+
+    <div class="mb-3">
+        <label for="whapi-auth-token" class="form-label">{{ $t("Token") }}</label>
+        <HiddenInput id="whapi-auth-token" v-model="$parent.notification.whapiAuthToken" :required="true" autocomplete="new-password"></HiddenInput>
+        <i18n-t tag="div" keypath="wayToGetWhapiUrlAndToken" class="form-text">
+            <a href="https://panel.whapi.cloud/dashboard" target="_blank">https://panel.whapi.cloud/dashboard</a>
+        </i18n-t>
+    </div>
+
+    <div class="mb-3">
+        <label for="whapi-recipient" class="form-label">{{ $t("whapiRecipient") }}</label>
+        <input id="whapi-recipient" v-model="$parent.notification.whapiRecipient" type="text" pattern="^[\d-]{10,31}(@[\w\.]{1,})?$" class="form-control" required>
+        <div class="form-text">{{ $t("wayToWriteWhapiRecipient", ["00117612345678", "[email protected]", "[email protected]"]) }}</div>
+    </div>
+
+    <i18n-t tag="div" keypath="More info on:" class="mb-3 form-text">
+        <a href="https://whapi.cloud/" target="_blank">https://whapi.cloud/</a>
+    </i18n-t>
+</template>
+<script>
+import HiddenInput from "../HiddenInput.vue";
+
+export default {
+    components: {
+        HiddenInput,
+    }
+};
+</script>

src/components/notifications/index.js

@@ -55,6 +55,7 @@ import WeCom from "./WeCom.vue";
 import GoAlert from "./GoAlert.vue";
 import ZohoCliq from "./ZohoCliq.vue";
 import Splunk from "./Splunk.vue";
+import Whapi from "./Whapi.vue";
 import Cellsynt from "./Cellsynt.vue";
 
 /**
@@ -118,6 +119,7 @@ const NotificationFormList = {
     "GoAlert": GoAlert,
     "ServerChan": ServerChan,
     "ZohoCliq": ZohoCliq,
+    "whapi": Whapi,
     "gtxmessaging": GtxMessaging,
     "Cellsynt": Cellsynt,
 };

src/lang/en.json

@@ -885,6 +885,10 @@
     "deleteRemoteBrowserMessage": "Are you sure want to delete this Remote Browser for all monitors?",
     "GrafanaOncallUrl": "Grafana Oncall URL",
     "Browser Screenshot": "Browser Screenshot",
+    "wayToWriteWhapiRecipient": "The phone number with the international prefix, but without the plus sign at the start ({0}), the Contact ID ({1}) or the Group ID ({2}).",
+    "wayToGetWhapiUrlAndToken": "You can get the API URL and the token by going into your desired channel from {0}",
+    "whapiRecipient": "Phone Number / Contact ID / Group ID",
+    "API URL": "API URL",
     "What is a Remote Browser?": "What is a Remote Browser?",
     "wayToGetHeiiOnCallDetails": "How to get the Trigger ID and API Keys is explained in the {documentation}",
     "documentationOf": "{0} Documentation",