Add Customer with Engage API on New Custom Object Property Change from HubSpot API

Pipedream makes it easy to connect APIs for Engage, HubSpot and 2,900+ other apps remarkably fast.

Trigger workflow on

New Custom Object Property Change from the HubSpot API

Next, do this

Add Customer with the Engage 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 Engage action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Custom Object Property Change trigger
1. Connect your HubSpot account
2. Configure timer
3. Select a Object Schema
4. Select a Property
Configure the Add Customer action
1. Connect your Engage account
2. Select a User ID
3. Select a Customer ID
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 Custom Object Property Change on HubSpot

Description:Emit new event when a specified property is provided or updated on a custom object.

Version:0.0.21

Key:hubspot-new-custom-object-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";

export default {
  ...common,
  key: "hubspot-new-custom-object-property-change",
  name: "New Custom Object Property Change",
  description:
    "Emit new event when a specified property is provided or updated on a custom object.",
  version: "0.0.21",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    objectSchema: {
      propDefinition: [
        common.props.hubspot,
        "objectSchema",
      ],
    },
    property: {
      type: "string",
      label: "Property",
      description: "The custom object property to watch for changes",
      async options() {
        const properties = await this.getWriteOnlyProperties(this.objectSchema);
        return properties.map((property) => property.name);
      },
    },
  },
  methods: {
    ...common.methods,
    getTs(object) {
      const history = object.propertiesWithHistory[this.property];
      if (!history || !(history.length > 0)) {
        return;
      }
      return Date.parse(history[0].timestamp);
    },
    generateMeta(object) {
      const {
        id, properties,
      } = object;
      const ts = this.getTs(object);
      return {
        id: `${id}${ts}`,
        summary: properties[this.property],
        ts,
      };
    },
    isRelevant(object, updatedAfter) {
      return this.getTs(object) > updatedAfter;
    },
    getParams(after) {
      const params = {
        object: this.objectSchema,
        data: {
          limit: DEFAULT_LIMIT,
          properties: [
            this.property,
          ],
          sorts: [
            {
              propertyName: "hs_lastmodifieddate",
              direction: "DESCENDING",
            },
          ],
          filterGroups: [
            {
              filters: [
                {
                  propertyName: this.property,
                  operator: "HAS_PROPERTY",
                },
              ],
            },
          ],
        },
      };
      if (after) {
        params.data.filterGroups[0].filters.push({
          propertyName: "hs_lastmodifieddate",
          operator: "GTE",
          value: after,
        });
      }
      return params;
    },
    batchGetCustomObjects(inputs) {
      return this.hubspot.batchGetObjects({
        objectType: this.objectSchema,
        data: {
          properties: [
            this.property,
          ],
          propertiesWithHistory: [
            this.property,
          ],
          inputs,
        },
      });
    },
    async processResults(after, params) {
      const properties = await this.getWriteOnlyProperties(this.objectSchema);
      const propertyNames = properties.map((property) => property.name);

      if (!propertyNames.includes(this.property)) {
        throw new Error(
          `Property "${this.property}" not supported for custom object ${this.objectSchema}.`,
        );
      }

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

      if (!updatedObjects.length) {
        return;
      }

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

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

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`
Object Schema	`objectSchema`	`string`	Select a value from the drop down menu.
Property	`property`	`string`	Select a value from the drop down menu.

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#

Add Customer on Engage

Description:Adds Customer to Accounts. [See the documentation](https://docs.engage.so/en-us/a/62bbdd015bfea4dca4834042-users#add-customer-to-accounts)

Version:0.0.2

Key:engage-add-customer

View on GitHub

Engage Overview#

The Engage API lets you automate and streamline your customer communication by sending personalized messages. With this API, you can craft interactions based on user behavior, preferences, and feedback. On Pipedream, you can integrate Engage with your workflow to trigger actions based on events from other apps, manage contact lists, and analyze communication patterns — all in real-time and without managing servers.

Action Code#

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

export default {
  key: "engage-add-customer",
  name: "Add Customer",
  description: "Adds Customer to Accounts. [See the documentation](https://docs.engage.so/en-us/a/62bbdd015bfea4dca4834042-users#add-customer-to-accounts)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    uid: {
      propDefinition: [
        app,
        "uid",
      ],
    },
    customerId: {
      propDefinition: [
        app,
        "customerId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.app.addCustomer({
      $,
      uid: this.uid,
      data: {
        accounts: [
          {
            id: this.customerId,
          },
        ],
      },
    });
    $.export("$summary", "add-customer executed successfully");
    return response;
  },
};

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
Engage	`app`	`app`	This component uses the Engage app.
User ID	`uid`	`string`	Select a value from the drop down menu.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.

Action Authentication#

Engage uses API keys for authentication. When you connect your Engage account, Pipedream securely stores the keys so you can easily authenticate to Engage APIs in both code and no-code steps.

To retrieve your API keys,

Navigate to your Engage account and sign in
Go to “Settings” > “Account”

Add Customer with Engage API on New Custom Object Property Change from HubSpot API

Pipedream makes it easy to connect APIs for Engage, HubSpot and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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