[#18193] - Hubspot Contact added to list trigger

components/hubspot/hubspot.app.mjs

@@ -1068,6 +1068,15 @@ export default {
         ...opts,
       });
     },
+    getListMembershipsByJoinOrder({
+      listId, ...opts
+    }) {
+      return this.makeRequest({
+        api: API_PATH.CRMV3,
+        endpoint: `/lists/${listId}/memberships/join-order`,
+        ...opts,
+      });
+    },
     batchGetObjects({
       objectType, ...opts
     }) {

components/hubspot/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/hubspot",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Pipedream Hubspot Components",
   "main": "hubspot.app.mjs",
   "keywords": [

components/hubspot/sources/new-contact-added-to-list/new-contact-added-to-list.mjs

@@ -0,0 +1,244 @@
+import common from "../common/common.mjs";
+import {
+  DEFAULT_LIMIT,
+  DEFAULT_CONTACT_PROPERTIES,
+} from "../../common/constants.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "hubspot-new-contact-added-to-list",
+  name: "New Contact Added to List",
+  description:
+    "Emit new event when a contact is added to a HubSpot list. [See the documentation](https://developers.hubspot.com/docs/reference/api/crm/lists#get-%2Fcrm%2Fv3%2Flists%2F%7Blistid%7D%2Fmemberships%2Fjoin-order)",
+  version: "0.0.10",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    info: {
+      type: "alert",
+      alertType: "info",
+      content: `Properties:\n\`${DEFAULT_CONTACT_PROPERTIES.join(", ")}\``,
+    },
+    listId: {
+      propDefinition: [
+        common.props.hubspot,
+        "listId",
+      ],
+      type: "string",
+      description: "Select the list to watch for new contacts.",
+      optional: false,
+    },
+    properties: {
+      propDefinition: [
+        common.props.hubspot,
+        "contactProperties",
+        () => ({
+          excludeDefaultProperties: true,
+        }),
+      ],
+      label: "Additional contact properties to retrieve",
+      optional: true,
+    },
+  },
+  methods: {
+    ...common.methods,
+    _getLastMembershipTimestamp(listId) {
+      const key = `list_${listId}_last_timestamp`;
+      return this.db.get(key);
+    },
+    _setLastMembershipTimestamp(listId, timestamp) {
+      const key = `list_${listId}_last_timestamp`;
+      this.db.set(key, timestamp);
+    },
+    getTs() {
+      return Date.now();
+    },
+    generateMeta(membership, listInfo) {
+      const { recordId } = membership;
+      const ts = this.getTs();
+
+      return {
+        id: `${listInfo.listId}-${recordId}`,
+        summary: `Contact ${recordId} added to list: ${listInfo.name}`,
+        ts,
+      };
+    },
+    async getContactDetails(contactIds) {
+      if (!contactIds.length) return {};
+
+      const uniqueContactIds = [
+        ...new Set(contactIds),
+      ];
+
+      const { properties = [] } = this;
+      const allProperties = [
+        ...new Set([
+          ...DEFAULT_CONTACT_PROPERTIES,
+          ...properties,
+        ]),
+      ];
+
+      const chunks = [];
+      const chunkSize = 100;
+      for (let i = 0; i < uniqueContactIds.length; i += chunkSize) {
+        chunks.push(uniqueContactIds.slice(i, i + chunkSize));
+      }
+
+      const contactMap = {};
+
+      const chunkPromises = chunks.map(async (chunk) => {
+        try {
+          const { results } = await this.hubspot.batchGetObjects({
+            objectType: "contacts",
+            data: {
+              inputs: chunk.map((id) => ({
+                id,
+              })),
+              properties: allProperties,
+            },
+          });
+          return results;
+        } catch (error) {
+          console.warn("Error fetching contact details for chunk:", error);
+          return [];
+        }
+      });
+
+      try {
+        const chunkResults = await Promise.all(chunkPromises);
+
+        chunkResults.forEach((results) => {
+          results.forEach((contact) => {
+            contactMap[contact.id] = contact;
+          });
+        });
+
+        return contactMap;
+      } catch (error) {
+        console.warn("Error processing contact details:", error);
+        return {};
+      }
+    },
+    async processListMemberships(listId, listInfo) {
+      const lastMembershipTimestamp = this._getLastMembershipTimestamp(listId);
+      const newMemberships = [];
+
+      let params = {
+        limit: DEFAULT_LIMIT,
+      };
+
+      try {
+        let hasMore = true;
+        let latestMembershipTimestamp = lastMembershipTimestamp;
+
+        if (!lastMembershipTimestamp) {
+          const baselineTimestamp = new Date().toISOString();
+          this._setLastMembershipTimestamp(listId, baselineTimestamp);
+          return newMemberships;
+        }
+
+        while (hasMore) {
+          const {
+            results, paging,
+          } =
+            await this.hubspot.getListMembershipsByJoinOrder({
+              listId,
+              params,
+            });
+
+          if (!results || results.length === 0) {
+            break;
+          }
+
+          for (const membership of results) {
+            const { membershipTimestamp } = membership;
+
+            if (
+              new Date(membershipTimestamp) > new Date(lastMembershipTimestamp)
+            ) {
+              newMemberships.push({
+                membership,
+                listInfo,
+              });
+
+              if (
+                !latestMembershipTimestamp ||
+                new Date(membershipTimestamp) >
+                  new Date(latestMembershipTimestamp)
+              ) {
+                latestMembershipTimestamp = membershipTimestamp;
+              }
+            }
+          }
+
+          if (paging?.next?.after) {
+            params.after = paging.next.after;
+          } else {
+            hasMore = false;
+          }
+        }
+
+        if (latestMembershipTimestamp !== lastMembershipTimestamp) {
+          this._setLastMembershipTimestamp(listId, latestMembershipTimestamp);
+        }
+      } catch (error) {
+        console.error(`Error processing list ${listId}:`, error);
+      }
+
+      return newMemberships;
+    },
+    async processResults() {
+      const { listId } = this;
+
+      if (!listId) {
+        console.warn("No list selected to monitor");
+        return;
+      }
+
+      const listInfo = {
+        listId,
+        name: `List ${listId}`,
+      };
+
+      try {
+        const newMemberships = await this.processListMemberships(
+          listId,
+          listInfo,
+        );
+
+        if (newMemberships.length > 0) {
+          const contactIds = newMemberships.map(
+            ({ membership }) => membership.recordId,
+          );
+          const contactDetails = await this.getContactDetails(contactIds);
+
+          for (const {
+            membership, listInfo,
+          } of newMemberships) {
+            const contactDetail = contactDetails[membership.recordId] || {};
+
+            const eventData = {
+              listId: listInfo.listId,
+              listName: listInfo.name,
+              contactId: membership.recordId,
+              contact: contactDetail,
+              membership,
+              addedAt: new Date().toISOString(),
+            };
+
+            const meta = this.generateMeta(membership, listInfo);
+            this.$emit(eventData, meta);
+          }
+        }
+      } catch (error) {
+        console.error(`Error processing list ${listId}:`, error);
+      }
+    },
+    getParams() {
+      return {};
+    },
+  },
+  sampleEmit,
+};

components/hubspot/sources/new-contact-added-to-list/test-event.mjs

@@ -0,0 +1,43 @@
+export default {
+  listId: "123456789",
+  listName: "List 123456789",
+  contactId: "31612976545",
+  contact: {
+    id: "31612976545",
+    properties: {
+      address: null,
+      annualrevenue: null,
+      city: "San Francisco",
+      company: "Acme Corp",
+      country: "United States",
+      createdate: "2024-08-26T15:30:45.123Z",
+      email: "[email protected]",
+      fax: null,
+      firstname: "John",
+      hs_createdate: "2024-08-26T15:30:45.123Z",
+      hs_email_domain: "example.com",
+      hs_language: null,
+      hs_object_id: "31612976545",
+      hs_persona: null,
+      industry: "Technology",
+      jobtitle: "Software Engineer",
+      lastmodifieddate: "2024-08-26T15:32:15.456Z",
+      lastname: "Doe",
+      lifecyclestage: "lead",
+      mobilephone: null,
+      numemployees: null,
+      phone: "+1-555-123-4567",
+      salutation: null,
+      state: "California",
+      website: "https://example.com",
+      zip: "94102",
+    },
+    createdAt: "2024-08-26T15:30:45.123Z",
+    updatedAt: "2024-08-26T15:32:15.456Z",
+    archived: false,
+  },
+  membership: {
+    recordId: "31612976545",
+  },
+  addedAt: "2024-08-26T15:35:20.789Z",
+};