Create Engagement with HubSpot API on New Authorized Sale Order from DEAR Systems API

Pipedream makes it easy to connect APIs for HubSpot, DEAR Systems and 2,400+ other apps remarkably fast.

Trigger workflow on

New Authorized Sale Order from the DEAR Systems API

Next, do this

Create Engagement with the HubSpot 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 DEAR Systems trigger and HubSpot action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Authorized Sale Order trigger
1. Connect your DEAR Systems account
Configure the Create Engagement action
1. Connect your HubSpot account
2. Select a Engagement Type
3. Optional- Select a Associated Object Type
4. Optional- Select a Associated Object
5. Optional- Select a Association Type
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 Authorized Sale Order on DEAR Systems

Description:Emit new event when a sale order is created and authorized

Version:0.0.3

Key:dear-new-authorized-sale-order

View on GitHub

DEAR Systems Overview#

DEAR Systems offers an API that provides programmatic access to its inventory management platform, allowing for seamless integration with other apps for automating various business processes. Leveraging this API within Pipedream, you can create custom workflows to synchronize inventory levels, manage sales and purchase orders, and automate financial reporting among other tasks. By connecting DEAR Systems to Pipedream’s vast array of supported apps, you can achieve a high degree of automation, reducing manual entry and data errors, and gaining insights from real-time data processing.

Trigger Code#

import constants from "../../common/constants.mjs";
import base from "../common/webhooks.mjs";

export default {
  ...base,
  name: "New Authorized Sale Order",
  key: "dear-new-authorized-sale-order",
  type: "source",
  description: "Emit new event when a sale order is created and authorized",
  version: "0.0.3",
  dedupe: "unique",
  methods: {
    ...base.methods,
    getWebhookType() {
      return constants.WEBHOOK_TYPE.SALE_ORDER_AUTHORISED;
    },
    getMetadata(payload) {
      const {
        amznTraceId,
        SaleID,
        SaleOrderNumber,
      } = payload;

      const compositeId = `${SaleID}-${amznTraceId}`;

      return {
        id: compositeId,
        summary: `A new sale order with OrderNumber: ${SaleOrderNumber} was successfully authorized!`,
        ts: Date.now(),
      };
    },
  },
};

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
DEAR Systems	`dear`	`app`	This component uses the DEAR Systems app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

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

To use the API you will need your DEAR Account ID and API Application key. These can be created on the API setup page inside DEAR Inventory application.

About DEAR Systems#

DEAR Inventory is a comprehensive inventory control application positioned as a complete back end management system with product planning, cost and development, manufacturing, sales, shipping and payment features.

Action#

Create Engagement on HubSpot

Description:Create a new engagement for a contact. [See the documentation](https://developers.hubspot.com/docs/api/crm/engagements)

Version:0.0.11

Key:hubspot-create-engagement

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.

Action Code#

import common from "../common/common-create.mjs";
import { ConfigurationError } from "@pipedream/platform";
import {
  ASSOCIATION_CATEGORY, ENGAGEMENT_TYPE_OPTIONS,
} from "../../common/constants.mjs";

export default {
  ...common,
  key: "hubspot-create-engagement",
  name: "Create Engagement",
  description: "Create a new engagement for a contact. [See the documentation](https://developers.hubspot.com/docs/api/crm/engagements)",
  version: "0.0.11",
  type: "action",
  props: {
    ...common.props,
    engagementType: {
      type: "string",
      label: "Engagement Type",
      description: "The type of engagement to create",
      reloadProps: true,
      options: ENGAGEMENT_TYPE_OPTIONS,
    },
    toObjectType: {
      propDefinition: [
        common.props.hubspot,
        "objectType",
      ],
      label: "Associated Object Type",
      description: "Type of object the engagement is being associated with",
      optional: true,
    },
    toObjectId: {
      propDefinition: [
        common.props.hubspot,
        "objectId",
        (c) => ({
          objectType: c.toObjectType,
        }),
      ],
      label: "Associated Object",
      description: "ID of object the engagement is being associated with",
      optional: true,
    },
    associationType: {
      propDefinition: [
        common.props.hubspot,
        "associationType",
        (c) => ({
          fromObjectType: c.engagementType,
          toObjectType: c.toObjectType,
        }),
      ],
      description: "A unique identifier to indicate the association type between the task and the other object",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getObjectType() {
      return this.engagementType;
    },
    isRelevantProperty(property) {
      return common.methods.isRelevantProperty(property) && !property.name.includes("hs_pipeline");
    },
    createEngagement(objectType, properties, associations, $) {
      return this.hubspot.createObject({
        objectType,
        data: {
          properties,
          associations,
        },
        $,
      });
    },
  },
  async run({ $ }) {
    const {
      hubspot,
      /* eslint-disable no-unused-vars */
      engagementType,
      toObjectType,
      toObjectId,
      associationType,
      $db,
      ...properties
    } = this;

    if ((toObjectId && !associationType) || (!toObjectId && associationType)) {
      throw new ConfigurationError("Both `toObjectId` and `associationType` must be entered");
    }

    const objectType = this.getObjectType();

    const associations = toObjectId
      ? [
        {
          to: {
            id: toObjectId,
          },
          types: [
            {
              associationTypeId: associationType,
              associationCategory: ASSOCIATION_CATEGORY.HUBSPOT_DEFINED,
            },
          ],
        },
      ]
      : undefined;

    if (properties.hs_task_reminders) {
      properties.hs_task_reminders = Date.parse(properties.hs_task_reminders);
    }

    const engagement = await this.createEngagement(objectType, properties, associations, $);

    const objectName = hubspot.getObjectTypeName(objectType);
    $.export("$summary", `Successfully created ${objectName} for the contact`);

    return engagement;
  },
};

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
HubSpot	`hubspot`	`app`	This component uses the HubSpot app.
Engagement Type	`engagementType`	`string`	Select a value from the drop down menu:`{ "label": "Note", "value": "notes" }{ "label": "Task", "value": "tasks" }{ "label": "Meeting", "value": "meetings" }{ "label": "Email", "value": "emails" }{ "label": "Call", "value": "calls" }`
Associated Object Type	`toObjectType`	`string`	Select a value from the drop down menu.
Associated Object	`toObjectId`	`string`	Select a value from the drop down menu.
Association Type	`associationType`	`string`	Select a value from the drop down menu.

Action 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.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.deals.writecrm.schemas.quotes.readconversations.readcrm.importfilesformsforms-uploaded-filesintegration-syncoauthtimeline

Create Engagement with HubSpot API on New Authorized Sale Order from DEAR Systems API

Pipedream makes it easy to connect APIs for HubSpot, DEAR Systems and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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