Find Text in Clusters with One AI API on New Contact Property Change from HubSpot API

Pipedream makes it easy to connect APIs for One AI, HubSpot and 2,800+ other apps remarkably fast.

Trigger workflow on

New Contact Property Change from the HubSpot API

Next, do this

Find Text in Clusters with the One AI API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a HubSpot trigger and One AI action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Contact Property Change trigger
1. Connect your HubSpot account
2. Configure timer
3. Select a Property
4. Optional- Configure Skip existing contacts when first activated
5. Optional- Configure Only trigger on actual property changes
Configure the Find Text in Clusters action
1. Connect your One AI account
2. Select a Collection
3. Configure Text
4. Optional- Configure Multilingual
5. Optional- Configure Translate
6. Optional- Configure Similarity Threshold
7. Optional- Configure Expected Language
8. Optional- Configure Override Language Detection
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Contact Property Change on HubSpot

Description:Emit new event when a specified property is provided or updated on a contact. [See the documentation](https://developers.hubspot.com/docs/api/crm/contacts)

Version:0.0.30

Key:hubspot-new-contact-property-change

View on GitHub

HubSpot Overview#

The HubSpot API enables developers to integrate into HubSpots CRM, CMS, Conversations, and other features. It allows for automated management of contacts, companies, deals, and marketing campaigns, enabling custom workflows, data synchronization, and task automation. This streamlines operations and boosts customer engagement, with real-time updates for rapid response to market changes.

Trigger Code#

import { DEFAULT_LIMIT } from "../../common/constants.mjs";
import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "hubspot-new-contact-property-change",
  name: "New Contact Property Change",
  description:
    "Emit new event when a specified property is provided or updated on a contact. [See the documentation](https://developers.hubspot.com/docs/api/crm/contacts)",
  version: "0.0.30",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    property: {
      type: "string",
      label: "Property",
      description: "The contact property to watch for changes",
      async options() {
        const properties = await this.hubspot.getContactProperties();
        return properties.map((property) => property.name);
      },
    },
    skipFirstRun: {
      type: "boolean",
      label: "Skip existing contacts when first activated",
      description:
        "When enabled, this trigger will ignore all existing contacts and only watch for property changes that happen after activation. When disabled, it will process all existing contacts on first run.",
      optional: true,
      default: false,
    },
    requirePropertyHistory: {
      type: "boolean",
      label: "Only trigger on actual property changes",
      description:
        "When enabled, only fires when a contact property is actually modified. When disabled, may also trigger for newly created contacts even if the property wasn't changed.",
      optional: true,
      default: true,
    },
  },
  methods: {
    ...common.methods,
    getTs(contact) {
      const history = contact.propertiesWithHistory[this.property];
      if (!history || !(history.length > 0)) {
        return;
      }
      return Date.parse(history[0].timestamp);
    },
    generateMeta(contact) {
      const {
        id, properties,
      } = contact;
      const ts = this.getTs(contact);
      return {
        id: `${id}${ts}`,
        summary: properties[this.property],
        ts,
      };
    },
    isRelevant(contact, updatedAfter) {
      if (this.requirePropertyHistory) {
        const history = contact.propertiesWithHistory?.[this.property];
        if (!history || history.length === 0) {
          return false;
        }

        const propertyTimestamp = history[0].timestamp;
        const createDate = contact.properties.createdate;

        if (propertyTimestamp === createDate) {
          return false;
        }
      }

      return this.getTs(contact) > updatedAfter;
    },
    getParams(after) {
      const params = {
        object: "contacts",
        data: {
          limit: DEFAULT_LIMIT,
          properties: [
            this.property,
          ],
          sorts: [
            {
              propertyName: "lastmodifieddate",
              direction: "DESCENDING",
            },
          ],
          filterGroups: [
            {
              filters: [
                {
                  propertyName: this.property,
                  operator: "HAS_PROPERTY",
                },
              ],
            },
          ],
        },
      };
      if (after) {
        params.data.filterGroups[0].filters.push({
          propertyName: "lastmodifieddate",
          operator: "GTE",
          value: after,
        });
      }
      return params;
    },
    batchGetContacts(inputs) {
      return this.hubspot.batchGetObjects({
        objectType: "contacts",
        data: {
          properties: [
            this.property,
          ],
          propertiesWithHistory: [
            this.property,
          ],
          inputs,
        },
      });
    },
    async processResults(after, params) {
      if (this.skipFirstRun && !after) {
        this._setAfter(Date.now());
        return;
      }

      const properties = await this.hubspot.getContactProperties();
      const propertyNames = properties.map((property) => property.name);
      if (!propertyNames.includes(this.property)) {
        throw new Error(
          `Property "${this.property}" not supported for Contacts. See Hubspot's default contact properties documentation - https://knowledge.hubspot.com/contacts/hubspots-default-contact-properties`,
        );
      }

      const updatedContacts = await this.getPaginatedItems(
        this.hubspot.searchCRM,
        params,
        after,
      );

      if (!updatedContacts.length) {
        return;
      }

      const results = await this.processChunks({
        batchRequestFn: this.batchGetContacts,
        chunks: this.getChunks(updatedContacts),
      });

      this.processEvents(results, after);
    },
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
HubSpot	`hubspot`	`app`	This component uses the HubSpot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Property	`property`	`string`	Select a value from the drop down menu.
Skip existing contacts when first activated	`skipFirstRun`	`boolean`	When enabled, this trigger will ignore all existing contacts and only watch for property changes that happen after activation. When disabled, it will process all existing contacts on first run.
Only trigger on actual property changes	`requirePropertyHistory`	`boolean`	When enabled, only fires when a contact property is actually modified. When disabled, may also trigger for newly created contacts even if the property wasn't changed.

Trigger Authentication#

HubSpot uses OAuth authentication. When you connect your HubSpot account, Pipedream will open a popup window where you can sign into HubSpot and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any HubSpot API.

Pipedream requests the following authorization scopes when you connect your account:

business-intelligencecrm.lists.readcrm.lists.writecrm.objects.companies.readcrm.objects.companies.writecrm.objects.contacts.readcrm.objects.contacts.writecrm.objects.deals.readcrm.objects.deals.writecrm.objects.quotes.readcrm.objects.quotes.writecrm.objects.owners.readcrm.objects.listings.writecrm.objects.listings.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.deals.writecrm.schemas.quotes.readcrm.schemas.listings.writecrm.schemas.listings.readconversations.readcrm.importfilesformsforms-uploaded-filesintegration-syncoauthtimeline

About HubSpot#

HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.

Action#

Find Text in Clusters on One AI

Description:Find clusters with a similar meaning of a given text. [See the documentation](https://docs.oneai.com/docs/find-text).

Version:0.0.1

Key:one_ai-find-text-in-clusters

View on GitHub

One AI Overview#

One AI API enables users to leverage advanced language AI to analyze and process text. On Pipedream, you can integrate One AI into serverless workflows to automate tasks like content summarization, emotion detection, or keyword extraction. By tapping into One AI's capabilities via Pipedream, you can enrich data, glean insights, and streamline content-centric operations with ease and efficiency.

Action Code#

import app from "../../one_ai.app.mjs";

export default {
  name: "Find Text in Clusters",
  description: "Find clusters with a similar meaning of a given text.  [See the documentation](https://docs.oneai.com/docs/find-text).",
  key: "one_ai-find-text-in-clusters",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    collection: {
      propDefinition: [
        app,
        "collection",
      ],
    },
    text: {
      type: "string",
      label: "Text",
      description: "Search Text",
    },
    multilingual: {
      type: "boolean",
      label: "Multilingual",
      description: "True if text is not in english",
      optional: true,
    },
    translate: {
      type: "boolean",
      label: "Translate",
      description: "Translate to English",
      optional: true,
    },
    similarityThreshold: {
      type: "string",
      label: "Similarity Threshold",
      description: "Minimum similarity of results (between 0 and 1)",
      optional: true,
    },
    expectedLanguage: {
      type: "string",
      label: "Expected Language",
      description: "Expected language of text",
      optional: true,
    },
    overrideLanguageDetection: {
      type: "boolean",
      label: "Override Language Detection",
      description: "Whether to override language detection",
      optional: true,
    },
  },
  async run({ $ }) {
    const res = await this.app.findTextInClusters(this.collection, {
      "text": this.text,
      "multilingual": this.multilingual,
      "translate": this.translate,
      "similarity_threshold": this.similarityThreshold,
      "expected-language": this.expectedLanguage,
      "override-language-detection": this.overrideLanguageDetection,
    });
    $.export("summary", `Successfully found ${res.length} cluster(s)`);
    return res;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
One AI	`app`	`app`	This component uses the One AI app.
Collection	`collection`	`string`	Select a value from the drop down menu.
Text	`text`	`string`	Search Text
Multilingual	`multilingual`	`boolean`	True if text is not in english
Translate	`translate`	`boolean`	Translate to English
Similarity Threshold	`similarityThreshold`	`string`	Minimum similarity of results (between 0 and 1)
Expected Language	`expectedLanguage`	`string`	Expected language of text
Override Language Detection	`overrideLanguageDetection`	`boolean`	Whether to override language detection

Find Text in Clusters with One AI API on New Contact Property Change from HubSpot API

Pipedream makes it easy to connect APIs for One AI, HubSpot and 2,800+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,800+apps by most popular

1
-
24
of
2,800+
apps by most popular