Webhook sources improvements

Author: GTFalcao

components/salesforge/sources/common/webhook.mjs

@@ -1,4 +1,3 @@
-import { v4 as uuid } from "uuid";
 import salesforge from "../../salesforge.app.mjs";
 
 export default {
@@ -21,11 +20,15 @@ export default {
       this.db.set("webhookId", webhookId);
     },
     generateMeta(data) {
-      const { id } = data;
+      const { webhookInfo } = data;
+      const ts = webhookInfo?.eventTime
+        ? new Date(webhookInfo.eventTime).valueOf()
+        : Date.now();
+      const id = `${this.getEventType()}-${ts}`;
       return {
-        id: id || uuid(),
+        id,
         summary: this.getSummary(data),
-        ts: Date.now(),
+        ts,
       };
     },
   },
@@ -41,15 +44,7 @@ export default {
       });
       this._setWebhookId(response.id);
     },
-    async deactivate() {
-      const webhookId = this._getWebhookId();
-      if (webhookId) {
-        await this.salesforge.deleteWebhook({
-          workspaceId: this.workspaceId,
-          webhookId,
-        });
-      }
-    },
+    // Salesforge does not seem to support deactivating/deleting webhooks via the API
   },
   async run(event) {
     const { body } = event;

components/salesforge/sources/contact-unsubscribed-instant/contact-unsubscribed-instant.mjs

@@ -0,0 +1,20 @@
+import common from "../common/webhook.mjs";
+
+export default {
+  ...common,
+  key: "salesforge-contact-unsubscribed-instant",
+  name: "Contact Unsubscribed (Instant)",
+  description: "Emit new event when a contact unsubscribes in Salesforge. [See the documentation](https://help.salesforge.ai/en/articles/8680365-how-to-use-webhooks)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventType() {
+      return "contact_unsubscribed";
+    },
+    getSummary({ contact }) {
+      return `Contact unsubscribed: ${contact?.email || "unknown contact"}`;
+    },
+  },
+};

components/salesforge/sources/email-bounced-instant/email-bounced-instant.mjs

@@ -0,0 +1,20 @@
+import common from "../common/webhook.mjs";
+
+export default {
+  ...common,
+  key: "salesforge-email-bounced-instant",
+  name: "Email Bounced (Instant)",
+  description: "Emit new event when an email bounces in Salesforge. [See the documentation](https://help.salesforge.ai/en/articles/8680365-how-to-use-webhooks)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventType() {
+      return "email_bounced";
+    },
+    getSummary({ contact }) {
+      return `Email bounced to ${contact?.email || "unknown recipient"}`;
+    },
+  },
+};

components/salesforge/sources/email-opened-instant/email-opened-instant.mjs

@@ -4,7 +4,7 @@ export default {
   ...common,
   key: "salesforge-email-opened-instant",
   name: "Email Opened (Instant)",
-  description: "Emit new event when an email is opened in Salesforge. [See the documentation](https://api.salesforge.ai/public/v2/swagger/index.html)",
+  description: "Emit new event when an email is opened in Salesforge. [See the documentation](https://help.salesforge.ai/en/articles/8680365-how-to-use-webhooks)",
   version: "0.0.1",
   type: "source",
   dedupe: "unique",
@@ -13,8 +13,8 @@ export default {
     getEventType() {
       return "email_opened";
     },
-    getSummary(data) {
-      return `Email opened: ${data.name || data.id}`;
+    getSummary({ sequenceEmail }) {
+      return `Email opened: "${sequenceEmail?.subject}"`;
     },
   },
 };

components/salesforge/sources/email-replied-instant/email-replied-instant.mjs

@@ -0,0 +1,20 @@
+import common from "../common/webhook.mjs";
+
+export default {
+  ...common,
+  key: "salesforge-email-replied-instant",
+  name: "Email Reply Received (Instant)",
+  description: "Emit new event when an email reply is received in Salesforge. [See the documentation](https://help.salesforge.ai/en/articles/8680365-how-to-use-webhooks)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventType() {
+      return "email_replied";
+    },
+    getSummary({ sequenceEmail }) {
+      return `Email reply received: "${sequenceEmail?.subject}"`;
+    },
+  },
+};

components/salesforge/sources/email-sent-instant/email-sent-instant.mjs

@@ -4,7 +4,7 @@ export default {
   ...common,
   key: "salesforge-email-sent-instant",
   name: "Email Sent (Instant)",
-  description: "Emit new event when an email is sent in Salesforge. [See the documentation](https://api.salesforge.ai/public/v2/swagger/index.html)",
+  description: "Emit new event when an email is sent in Salesforge. [See the documentation](https://help.salesforge.ai/en/articles/8680365-how-to-use-webhooks)",
   version: "0.0.1",
   type: "source",
   dedupe: "unique",
@@ -13,8 +13,8 @@ export default {
     getEventType() {
       return "email_sent";
     },
-    getSummary(data) {
-      return `Email sent: ${data.name || data.id}`;
+    getSummary({ sequenceEmail }) {
+      return `Email sent: "${sequenceEmail?.subject}"`;
     },
   },
 };

components/salesforge/sources/link-clicked-instant/link-clicked-instant.mjs

@@ -4,7 +4,7 @@ export default {
   ...common,
   key: "salesforge-link-clicked-instant",
   name: "Link Clicked (Instant)",
-  description: "Emit new event when a link is clicked in Salesforge. [See the documentation](https://api.salesforge.ai/public/v2/swagger/index.html)",
+  description: "Emit new event when a link is clicked in Salesforge. [See the documentation](https://help.salesforge.ai/en/articles/8680365-how-to-use-webhooks)",
   version: "0.0.1",
   type: "source",
   dedupe: "unique",
@@ -13,8 +13,10 @@ export default {
     getEventType() {
       return "link_clicked";
     },
-    getSummary(data) {
-      return `Link clicked: ${data.name || data.url || data.id}`;
+    getSummary({
+      sequenceEmail, linkUrl,
+    }) {
+      return `Link clicked: ${linkUrl} in "${sequenceEmail?.subject}"`;
     },
   },
 };

components/salesforge/sources/negative-reply-instant/negative-reply-instant.mjs

@@ -0,0 +1,20 @@
+import common from "../common/webhook.mjs";
+
+export default {
+  ...common,
+  key: "salesforge-negative-reply-instant",
+  name: "Negative Reply Received (Instant)",
+  description: "Emit new event when a negative reply is received in Salesforge. [See the documentation](https://help.salesforge.ai/en/articles/8680365-how-to-use-webhooks)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventType() {
+      return "negative_reply";
+    },
+    getSummary({ contact }) {
+      return `Negative reply received from ${contact?.email || "unknown contact"}`;
+    },
+  },
+};