Add Heii On-Call Notification Provider (#4485)

server/notification-providers/heii-oncall.js

@@ -0,0 +1,52 @@
+const { UP, DOWN, getMonitorRelativeURL } = require("../../src/util");
+const { setting } = require("../util-server");
+
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+class HeiiOnCall extends NotificationProvider {
+    name = "HeiiOnCall";
+
+    /**
+     * @inheritdoc
+     */
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        const okMsg = "Sent Successfully.";
+        const payload = heartbeatJSON || {};
+
+        const baseURL = await setting("primaryBaseURL");
+        if (baseURL && monitorJSON) {
+            payload["url"] = baseURL + getMonitorRelativeURL(monitorJSON.id);
+        }
+
+        const config = {
+            headers: {
+                Accept: "application/json",
+                "Content-Type": "application/json",
+                Authorization: "Bearer " + notification.heiiOnCallApiKey,
+            },
+        };
+        const heiiUrl = `https://heiioncall.com/triggers/${notification.heiiOnCallTriggerId}/`;
+        // docs https://heiioncall.com/docs#manual-triggers
+        try {
+            if (!heartbeatJSON) {
+                // Testing or general notification like certificate expiry
+                payload["msg"] = msg;
+                await axios.post(heiiUrl + "alert", payload, config);
+                return okMsg;
+            }
+
+            if (heartbeatJSON.status === DOWN) {
+                await axios.post(heiiUrl + "alert", payload, config);
+                return okMsg;
+            }
+            if (heartbeatJSON.status === UP) {
+                await axios.post(heiiUrl + "resolve", payload, config);
+                return okMsg;
+            }
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+}
+
+module.exports = HeiiOnCall;

server/notification.js

@@ -16,6 +16,7 @@ const Gorush = require("./notification-providers/gorush");
 const Gotify = require("./notification-providers/gotify");
 const GrafanaOncall = require("./notification-providers/grafana-oncall");
 const HomeAssistant = require("./notification-providers/home-assistant");
+const HeiiOnCall = require("./notification-providers/heii-oncall");
 const Kook = require("./notification-providers/kook");
 const Line = require("./notification-providers/line");
 const LineNotify = require("./notification-providers/linenotify");
@@ -87,6 +88,7 @@ class Notification {
             new Gotify(),
             new GrafanaOncall(),
             new HomeAssistant(),
+            new HeiiOnCall(),
             new Kook(),
             new Line(),
             new LineNotify(),

src/components/NotificationDialog.vue

@@ -120,6 +120,7 @@ export default {
                 "gorush": "Gorush",
                 "gotify": "Gotify",
                 "GrafanaOncall": "Grafana Oncall",
+                "HeiiOnCall": "Heii On-Call",
                 "HomeAssistant": "Home Assistant",
                 "Kook": "Kook",
                 "line": "LINE Messenger",

src/components/notifications/HeiiOnCall.vue

@@ -0,0 +1,34 @@
+<template>
+    <div class="mb-3">
+        <label for="heiioncall-apikey" class="form-label">{{ $t("API Key") }}<span
+            style="color: red;"
+        ><sup>*</sup></span></label>
+        <HiddenInput
+            id="heiioncall-apikey" v-model="$parent.notification.heiiOnCallApiKey" required="true"
+            autocomplete="false"
+        ></HiddenInput>
+    </div>
+    <div class="mb-3">
+        <label for="heiioncall-trigger-id" class="form-label">Trigger ID<span
+            style="color: red;"
+        ><sup>*</sup></span></label>
+        <HiddenInput
+            id="heiioncall-trigger-id" v-model="$parent.notification.heiiOnCallTriggerId" required="true"
+            autocomplete="false"
+        ></HiddenInput>
+    </div>
+    <i18n-t tag="p" keypath="wayToGetHeiiOnCallDetails" class="form-text mt-3">
+        <template #documentation>
+            <a href="https://heiioncall.com/docs" target="_blank">{{ $t("documentationOf", ["Heii On-Call"]) }}</a>
+        </template>
+    </i18n-t>
+</template>
+
+<script>
+import HiddenInput from "../HiddenInput.vue";
+export default {
+    components: {
+        HiddenInput,
+    },
+};
+</script>

src/components/notifications/index.js

@@ -14,6 +14,7 @@ import Gorush from "./Gorush.vue";
 import Gotify from "./Gotify.vue";
 import GrafanaOncall from "./GrafanaOncall.vue";
 import HomeAssistant from "./HomeAssistant.vue";
+import HeiiOnCall from "./HeiiOnCall.vue";
 import Kook from "./Kook.vue";
 import Line from "./Line.vue";
 import LineNotify from "./LineNotify.vue";
@@ -74,6 +75,7 @@ const NotificationFormList = {
     "gotify": Gotify,
     "GrafanaOncall": GrafanaOncall,
     "HomeAssistant": HomeAssistant,
+    "HeiiOnCall": HeiiOnCall,
     "Kook": Kook,
     "line": Line,
     "LineNotify": LineNotify,

src/lang/en.json

@@ -885,5 +885,7 @@
     "deleteRemoteBrowserMessage": "Are you sure want to delete this Remote Browser for all monitors?",
     "GrafanaOncallUrl": "Grafana Oncall URL",
     "Browser Screenshot": "Browser Screenshot",
-    "What is a Remote Browser?": "What is a Remote Browser?"
+    "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"
 }