@oneuptime/common 10.2.1 → 10.2.3

package/build/dist/Server/Services/UserNotificationRuleService.js

@@ -17,6 +17,7 @@ import MailService from "./MailService";
 import ShortLinkService from "./ShortLinkService";
 import SmsService from "./SmsService";
 import TelegramService from "./TelegramService";
+import WebhookService from "./WebhookService";
 import WhatsAppService from "./WhatsAppService";
 import UserEmailService from "./UserEmailService";
 import UserOnCallLogService from "./UserOnCallLogService";
@@ -61,7 +62,7 @@ export class Service extends DatabaseService {
     }
     async executeNotificationRuleItem(userNotificationRuleId, options) {
         // get user notification log and see if this rule has already been executed. If so then skip.
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28, _29, _30, _31, _32, _33, _34, _35, _36, _37, _38, _39, _40, _41, _42, _43, _44, _45, _46, _47, _48, _49;
         const userOnCallLog = await UserOnCallLogService.findOneById({
             id: options.userNotificationLogId,
             props: {
@@ -116,6 +117,11 @@ export class Service extends DatabaseService {
                     telegramUserHandle: true,
                     isVerified: true,
                 },
+                userWebhook: {
+                    webhookUrl: true,
+                    name: true,
+                    secret: true,
+                },
                 userEmail: {
                     email: true,
                     isVerified: true,
@@ -817,16 +823,159 @@ export class Service extends DatabaseService {
                 },
             });
         }
+        // send webhook.
+        if ((_6 = notificationRuleItem.userWebhook) === null || _6 === void 0 ? void 0 : _6.webhookUrl) {
+            const webhookUrl = notificationRuleItem.userWebhook.webhookUrl;
+            const webhookSecret = notificationRuleItem.userWebhook.secret;
+            const userWebhookId = notificationRuleItem.userWebhook.id;
+            const dispatchWebhook = async (params) => {
+                logTimelineItem.status = UserNotificationStatus.Sending;
+                logTimelineItem.statusMessage = `Sending webhook to ${webhookUrl}.`;
+                logTimelineItem.userWebhookId = userWebhookId;
+                const updatedLog = await UserOnCallLogTimelineService.create({
+                    data: logTimelineItem,
+                    props: {
+                        isRoot: true,
+                    },
+                });
+                const callbacksByKind = {};
+                if (params.entityKind === "alert" && params.entityId) {
+                    callbacksByKind.alert = { alertId: params.entityId };
+                }
+                else if (params.entityKind === "incident" && params.entityId) {
+                    callbacksByKind.incident = { incidentId: params.entityId };
+                }
+                WebhookService.sendWebhook({
+                    url: webhookUrl,
+                    eventType: params.eventType,
+                    payload: params.payload,
+                    secret: webhookSecret,
+                }, Object.assign(Object.assign({ projectId: options.projectId, userOnCallLogTimelineId: updatedLog.id, userId: notificationRuleItem.userId, onCallPolicyId: options.onCallPolicyId, onCallPolicyEscalationRuleId: options.onCallPolicyEscalationRuleId, teamId: options.userBelongsToTeamId, onCallDutyPolicyExecutionLogTimelineId: options.onCallDutyPolicyExecutionLogTimelineId, onCallScheduleId: options.onCallScheduleId }, callbacksByKind.alert), callbacksByKind.incident)).catch(async (err) => {
+                    await UserOnCallLogTimelineService.updateOneById({
+                        id: updatedLog.id,
+                        data: {
+                            status: UserNotificationStatus.Error,
+                            statusMessage: err.message || "Error sending webhook.",
+                        },
+                        props: {
+                            isRoot: true,
+                        },
+                    });
+                });
+            };
+            if (options.userNotificationEventType ===
+                UserNotificationEventType.AlertCreated &&
+                alert) {
+                await dispatchWebhook({
+                    eventType: "on-call.alert.created",
+                    entityKind: "alert",
+                    entityId: alert.id,
+                    payload: {
+                        eventType: "on-call.alert.created",
+                        timestamp: new Date().toISOString(),
+                        projectId: ((_7 = alert.projectId) === null || _7 === void 0 ? void 0 : _7.toString()) || "",
+                        userId: notificationRuleItem.userId.toString(),
+                        alert: {
+                            id: ((_8 = alert.id) === null || _8 === void 0 ? void 0 : _8.toString()) || "",
+                            title: alert.title || "",
+                            description: alert.description || "",
+                            alertNumber: alert.alertNumber || null,
+                            alertNumberWithPrefix: alert.alertNumberWithPrefix || null,
+                            severity: ((_9 = alert.alertSeverity) === null || _9 === void 0 ? void 0 : _9.name) || null,
+                            state: ((_10 = alert.currentAlertState) === null || _10 === void 0 ? void 0 : _10.name) || null,
+                        },
+                        onCallPolicyId: ((_11 = options.onCallPolicyId) === null || _11 === void 0 ? void 0 : _11.toString()) || null,
+                        onCallPolicyEscalationRuleId: ((_12 = options.onCallPolicyEscalationRuleId) === null || _12 === void 0 ? void 0 : _12.toString()) || null,
+                    },
+                });
+            }
+            if (options.userNotificationEventType ===
+                UserNotificationEventType.IncidentCreated &&
+                incident) {
+                await dispatchWebhook({
+                    eventType: "on-call.incident.created",
+                    entityKind: "incident",
+                    entityId: incident.id,
+                    payload: {
+                        eventType: "on-call.incident.created",
+                        timestamp: new Date().toISOString(),
+                        projectId: ((_13 = incident.projectId) === null || _13 === void 0 ? void 0 : _13.toString()) || "",
+                        userId: notificationRuleItem.userId.toString(),
+                        incident: {
+                            id: ((_14 = incident.id) === null || _14 === void 0 ? void 0 : _14.toString()) || "",
+                            title: incident.title || "",
+                            description: incident.description || "",
+                            incidentNumber: incident.incidentNumber || null,
+                            incidentNumberWithPrefix: incident.incidentNumberWithPrefix || null,
+                            severity: ((_15 = incident.incidentSeverity) === null || _15 === void 0 ? void 0 : _15.name) || null,
+                            state: ((_16 = incident.currentIncidentState) === null || _16 === void 0 ? void 0 : _16.name) || null,
+                        },
+                        onCallPolicyId: ((_17 = options.onCallPolicyId) === null || _17 === void 0 ? void 0 : _17.toString()) || null,
+                        onCallPolicyEscalationRuleId: ((_18 = options.onCallPolicyEscalationRuleId) === null || _18 === void 0 ? void 0 : _18.toString()) || null,
+                    },
+                });
+            }
+            if (options.userNotificationEventType ===
+                UserNotificationEventType.AlertEpisodeCreated &&
+                alertEpisode) {
+                await dispatchWebhook({
+                    eventType: "on-call.alertEpisode.created",
+                    entityKind: "alertEpisode",
+                    payload: {
+                        eventType: "on-call.alertEpisode.created",
+                        timestamp: new Date().toISOString(),
+                        projectId: ((_19 = alertEpisode.projectId) === null || _19 === void 0 ? void 0 : _19.toString()) || "",
+                        userId: notificationRuleItem.userId.toString(),
+                        alertEpisode: {
+                            id: ((_20 = alertEpisode.id) === null || _20 === void 0 ? void 0 : _20.toString()) || "",
+                            title: alertEpisode.title || "",
+                            description: alertEpisode.description || "",
+                            episodeNumber: alertEpisode.episodeNumber || null,
+                            episodeNumberWithPrefix: alertEpisode.episodeNumberWithPrefix || null,
+                            severity: ((_21 = alertEpisode.alertSeverity) === null || _21 === void 0 ? void 0 : _21.name) || null,
+                            state: ((_22 = alertEpisode.currentAlertState) === null || _22 === void 0 ? void 0 : _22.name) || null,
+                        },
+                        onCallPolicyId: ((_23 = options.onCallPolicyId) === null || _23 === void 0 ? void 0 : _23.toString()) || null,
+                        onCallPolicyEscalationRuleId: ((_24 = options.onCallPolicyEscalationRuleId) === null || _24 === void 0 ? void 0 : _24.toString()) || null,
+                    },
+                });
+            }
+            if (options.userNotificationEventType ===
+                UserNotificationEventType.IncidentEpisodeCreated &&
+                incidentEpisode) {
+                await dispatchWebhook({
+                    eventType: "on-call.incidentEpisode.created",
+                    entityKind: "incidentEpisode",
+                    payload: {
+                        eventType: "on-call.incidentEpisode.created",
+                        timestamp: new Date().toISOString(),
+                        projectId: ((_25 = incidentEpisode.projectId) === null || _25 === void 0 ? void 0 : _25.toString()) || "",
+                        userId: notificationRuleItem.userId.toString(),
+                        incidentEpisode: {
+                            id: ((_26 = incidentEpisode.id) === null || _26 === void 0 ? void 0 : _26.toString()) || "",
+                            title: incidentEpisode.title || "",
+                            description: incidentEpisode.description || "",
+                            episodeNumber: incidentEpisode.episodeNumber || null,
+                            episodeNumberWithPrefix: incidentEpisode.episodeNumberWithPrefix || null,
+                            severity: ((_27 = incidentEpisode.incidentSeverity) === null || _27 === void 0 ? void 0 : _27.name) || null,
+                            state: ((_28 = incidentEpisode.currentIncidentState) === null || _28 === void 0 ? void 0 : _28.name) || null,
+                        },
+                        onCallPolicyId: ((_29 = options.onCallPolicyId) === null || _29 === void 0 ? void 0 : _29.toString()) || null,
+                        onCallPolicyEscalationRuleId: ((_30 = options.onCallPolicyEscalationRuleId) === null || _30 === void 0 ? void 0 : _30.toString()) || null,
+                    },
+                });
+            }
+        }
         // send call.
-        if (((_6 = notificationRuleItem.userCall) === null || _6 === void 0 ? void 0 : _6.phone) &&
-            ((_7 = notificationRuleItem.userCall) === null || _7 === void 0 ? void 0 : _7.isVerified)) {
+        if (((_31 = notificationRuleItem.userCall) === null || _31 === void 0 ? void 0 : _31.phone) &&
+            ((_32 = notificationRuleItem.userCall) === null || _32 === void 0 ? void 0 : _32.isVerified)) {
             // send call for alert
             if (options.userNotificationEventType ===
                 UserNotificationEventType.AlertCreated &&
                 alert) {
                 // create an error log.
                 logTimelineItem.status = UserNotificationStatus.Sending;
-                logTimelineItem.statusMessage = `Making a call to ${(_8 = notificationRuleItem.userCall) === null || _8 === void 0 ? void 0 : _8.phone.toString()}.`;
+                logTimelineItem.statusMessage = `Making a call to ${(_33 = notificationRuleItem.userCall) === null || _33 === void 0 ? void 0 : _33.phone.toString()}.`;
                 logTimelineItem.userCallId = notificationRuleItem.userCall.id;
                 const updatedLog = await UserOnCallLogTimelineService.create({
                     data: logTimelineItem,
@@ -834,7 +983,7 @@ export class Service extends DatabaseService {
                         isRoot: true,
                     },
                 });
-                const callRequest = await this.generateCallTemplateForAlertCreated((_9 = notificationRuleItem.userCall) === null || _9 === void 0 ? void 0 : _9.phone, alert, updatedLog.id);
+                const callRequest = await this.generateCallTemplateForAlertCreated((_34 = notificationRuleItem.userCall) === null || _34 === void 0 ? void 0 : _34.phone, alert, updatedLog.id);
                 // send call.
                 CallService.makeCall(callRequest, {
                     projectId: alert.projectId,
@@ -864,7 +1013,7 @@ export class Service extends DatabaseService {
                 incident) {
                 // send call for incident
                 logTimelineItem.status = UserNotificationStatus.Sending;
-                logTimelineItem.statusMessage = `Making a call to ${(_10 = notificationRuleItem.userCall) === null || _10 === void 0 ? void 0 : _10.phone.toString()}.`;
+                logTimelineItem.statusMessage = `Making a call to ${(_35 = notificationRuleItem.userCall) === null || _35 === void 0 ? void 0 : _35.phone.toString()}.`;
                 logTimelineItem.userCallId = notificationRuleItem.userCall.id;
                 const updatedLog = await UserOnCallLogTimelineService.create({
                     data: logTimelineItem,
@@ -872,7 +1021,7 @@ export class Service extends DatabaseService {
                         isRoot: true,
                     },
                 });
-                const callRequest = await this.generateCallTemplateForIncidentCreated((_11 = notificationRuleItem.userCall) === null || _11 === void 0 ? void 0 : _11.phone, incident, updatedLog.id);
+                const callRequest = await this.generateCallTemplateForIncidentCreated((_36 = notificationRuleItem.userCall) === null || _36 === void 0 ? void 0 : _36.phone, incident, updatedLog.id);
                 // send call.
                 CallService.makeCall(callRequest, {
                     projectId: incident.projectId,
@@ -902,7 +1051,7 @@ export class Service extends DatabaseService {
                 UserNotificationEventType.AlertEpisodeCreated &&
                 alertEpisode) {
                 logTimelineItem.status = UserNotificationStatus.Sending;
-                logTimelineItem.statusMessage = `Making a call to ${(_12 = notificationRuleItem.userCall) === null || _12 === void 0 ? void 0 : _12.phone.toString()}.`;
+                logTimelineItem.statusMessage = `Making a call to ${(_37 = notificationRuleItem.userCall) === null || _37 === void 0 ? void 0 : _37.phone.toString()}.`;
                 logTimelineItem.userCallId = notificationRuleItem.userCall.id;
                 const updatedLog = await UserOnCallLogTimelineService.create({
                     data: logTimelineItem,
@@ -910,7 +1059,7 @@ export class Service extends DatabaseService {
                         isRoot: true,
                     },
                 });
-                const callRequest = await this.generateCallTemplateForAlertEpisodeCreated((_13 = notificationRuleItem.userCall) === null || _13 === void 0 ? void 0 : _13.phone, alertEpisode, updatedLog.id);
+                const callRequest = await this.generateCallTemplateForAlertEpisodeCreated((_38 = notificationRuleItem.userCall) === null || _38 === void 0 ? void 0 : _38.phone, alertEpisode, updatedLog.id);
                 CallService.makeCall(callRequest, {
                     projectId: alertEpisode.projectId,
                     userOnCallLogTimelineId: updatedLog.id,
@@ -935,11 +1084,11 @@ export class Service extends DatabaseService {
                 });
             }
         }
-        if (((_14 = notificationRuleItem.userCall) === null || _14 === void 0 ? void 0 : _14.phone) &&
-            !((_15 = notificationRuleItem.userCall) === null || _15 === void 0 ? void 0 : _15.isVerified)) {
+        if (((_39 = notificationRuleItem.userCall) === null || _39 === void 0 ? void 0 : _39.phone) &&
+            !((_40 = notificationRuleItem.userCall) === null || _40 === void 0 ? void 0 : _40.isVerified)) {
             // create a log.
             logTimelineItem.status = UserNotificationStatus.Error;
-            logTimelineItem.statusMessage = `Call not sent because phone ${(_16 = notificationRuleItem.userCall) === null || _16 === void 0 ? void 0 : _16.phone.toString()} is not verified.`;
+            logTimelineItem.statusMessage = `Call not sent because phone ${(_41 = notificationRuleItem.userCall) === null || _41 === void 0 ? void 0 : _41.phone.toString()} is not verified.`;
             await UserOnCallLogTimelineService.create({
                 data: logTimelineItem,
                 props: {
@@ -948,8 +1097,8 @@ export class Service extends DatabaseService {
             });
         }
         // send push notification.
-        if (((_17 = notificationRuleItem.userPush) === null || _17 === void 0 ? void 0 : _17.deviceToken) &&
-            ((_18 = notificationRuleItem.userPush) === null || _18 === void 0 ? void 0 : _18.isVerified)) {
+        if (((_42 = notificationRuleItem.userPush) === null || _42 === void 0 ? void 0 : _42.deviceToken) &&
+            ((_43 = notificationRuleItem.userPush) === null || _43 === void 0 ? void 0 : _43.isVerified)) {
             // send push notification for alert
             if (options.userNotificationEventType ===
                 UserNotificationEventType.AlertCreated &&
@@ -964,7 +1113,7 @@ export class Service extends DatabaseService {
                         isRoot: true,
                     },
                 });
-                const pushMessage = PushNotificationUtil.createAlertCreatedNotification(Object.assign(Object.assign(Object.assign({ alertTitle: alert.title, projectName: ((_19 = alert.project) === null || _19 === void 0 ? void 0 : _19.name) || "OneUptime", alertViewLink: (await AlertService.getAlertLinkInDashboard(alert.projectId, alert.id)).toString() }, (alert.alertNumber !== undefined && {
+                const pushMessage = PushNotificationUtil.createAlertCreatedNotification(Object.assign(Object.assign(Object.assign({ alertTitle: alert.title, projectName: ((_44 = alert.project) === null || _44 === void 0 ? void 0 : _44.name) || "OneUptime", alertViewLink: (await AlertService.getAlertLinkInDashboard(alert.projectId, alert.id)).toString() }, (alert.alertNumber !== undefined && {
                     alertNumber: alert.alertNumber,
                 })), (alert.alertNumberWithPrefix && {
                     alertNumberWithPrefix: alert.alertNumberWithPrefix,
@@ -1016,7 +1165,7 @@ export class Service extends DatabaseService {
                         isRoot: true,
                     },
                 });
-                const pushMessage = PushNotificationUtil.createIncidentCreatedNotification(Object.assign(Object.assign(Object.assign({ incidentTitle: incident.title, projectName: ((_20 = incident.project) === null || _20 === void 0 ? void 0 : _20.name) || "OneUptime", incidentViewLink: (await IncidentService.getIncidentLinkInDashboard(incident.projectId, incident.id)).toString() }, (incident.incidentNumber !== undefined && {
+                const pushMessage = PushNotificationUtil.createIncidentCreatedNotification(Object.assign(Object.assign(Object.assign({ incidentTitle: incident.title, projectName: ((_45 = incident.project) === null || _45 === void 0 ? void 0 : _45.name) || "OneUptime", incidentViewLink: (await IncidentService.getIncidentLinkInDashboard(incident.projectId, incident.id)).toString() }, (incident.incidentNumber !== undefined && {
                     incidentNumber: incident.incidentNumber,
                 })), (incident.incidentNumberWithPrefix && {
                     incidentNumberWithPrefix: incident.incidentNumberWithPrefix,
@@ -1067,7 +1216,7 @@ export class Service extends DatabaseService {
                         isRoot: true,
                     },
                 });
-                const pushMessage = PushNotificationUtil.createAlertEpisodeCreatedNotification(Object.assign(Object.assign(Object.assign({ alertEpisodeTitle: alertEpisode.title, projectName: ((_21 = alertEpisode.project) === null || _21 === void 0 ? void 0 : _21.name) || "OneUptime", alertEpisodeViewLink: (await AlertEpisodeService.getEpisodeLinkInDashboard(alertEpisode.projectId, alertEpisode.id)).toString() }, (alertEpisode.episodeNumber !== undefined && {
+                const pushMessage = PushNotificationUtil.createAlertEpisodeCreatedNotification(Object.assign(Object.assign(Object.assign({ alertEpisodeTitle: alertEpisode.title, projectName: ((_46 = alertEpisode.project) === null || _46 === void 0 ? void 0 : _46.name) || "OneUptime", alertEpisodeViewLink: (await AlertEpisodeService.getEpisodeLinkInDashboard(alertEpisode.projectId, alertEpisode.id)).toString() }, (alertEpisode.episodeNumber !== undefined && {
                     episodeNumber: alertEpisode.episodeNumber,
                 })), (alertEpisode.episodeNumberWithPrefix && {
                     episodeNumberWithPrefix: alertEpisode.episodeNumberWithPrefix,
@@ -1117,7 +1266,7 @@ export class Service extends DatabaseService {
                         isRoot: true,
                     },
                 });
-                const pushMessage = PushNotificationUtil.createIncidentEpisodeCreatedNotification(Object.assign(Object.assign(Object.assign({ incidentEpisodeTitle: incidentEpisode.title, projectName: ((_22 = incidentEpisode.project) === null || _22 === void 0 ? void 0 : _22.name) || "OneUptime", incidentEpisodeViewLink: (await IncidentEpisodeService.getEpisodeLinkInDashboard(incidentEpisode.projectId, incidentEpisode.id)).toString() }, (incidentEpisode.episodeNumber !== undefined && {
+                const pushMessage = PushNotificationUtil.createIncidentEpisodeCreatedNotification(Object.assign(Object.assign(Object.assign({ incidentEpisodeTitle: incidentEpisode.title, projectName: ((_47 = incidentEpisode.project) === null || _47 === void 0 ? void 0 : _47.name) || "OneUptime", incidentEpisodeViewLink: (await IncidentEpisodeService.getEpisodeLinkInDashboard(incidentEpisode.projectId, incidentEpisode.id)).toString() }, (incidentEpisode.episodeNumber !== undefined && {
                     episodeNumber: incidentEpisode.episodeNumber,
                 })), (incidentEpisode.episodeNumberWithPrefix && {
                     episodeNumberWithPrefix: incidentEpisode.episodeNumberWithPrefix,
@@ -1154,8 +1303,8 @@ export class Service extends DatabaseService {
                 });
             }
         }
-        if (((_23 = notificationRuleItem.userPush) === null || _23 === void 0 ? void 0 : _23.deviceToken) &&
-            !((_24 = notificationRuleItem.userPush) === null || _24 === void 0 ? void 0 : _24.isVerified)) {
+        if (((_48 = notificationRuleItem.userPush) === null || _48 === void 0 ? void 0 : _48.deviceToken) &&
+            !((_49 = notificationRuleItem.userPush) === null || _49 === void 0 ? void 0 : _49.isVerified)) {
             // create a log.
             logTimelineItem.status = UserNotificationStatus.Error;
             logTimelineItem.statusMessage = `Push notification not sent because device is not verified.`;
@@ -1798,10 +1947,12 @@ export class Service extends DatabaseService {
             !createBy.data.userWhatsAppId &&
             !createBy.data.userTelegram &&
             !createBy.data.userTelegramId &&
+            !createBy.data.userWebhook &&
+            !createBy.data.userWebhookId &&
             !createBy.data.userEmailId &&
             !createBy.data.userPushId &&
             !createBy.data.userPush) {
-            throw new BadDataException("Call, SMS, WhatsApp, Telegram, Email, or Push notification is required");
+            throw new BadDataException("Call, SMS, WhatsApp, Telegram, Webhook, Email, or Push notification is required");
         }
         return {
             createBy,
@@ -1833,6 +1984,9 @@ export class Service extends DatabaseService {
         if (descriptor.userTelegramId) {
             rule.userTelegramId = descriptor.userTelegramId;
         }
+        if (descriptor.userWebhookId) {
+            rule.userWebhookId = descriptor.userWebhookId;
+        }
         if (descriptor.userPushId) {
             rule.userPushId = descriptor.userPushId;
         }
@@ -1854,6 +2008,9 @@ export class Service extends DatabaseService {
         if (descriptor.userTelegramId) {
             query["userTelegramId"] = descriptor.userTelegramId;
         }
+        if (descriptor.userWebhookId) {
+            query["userWebhookId"] = descriptor.userWebhookId;
+        }
         if (descriptor.userPushId) {
             query["userPushId"] = descriptor.userPushId;
         }