Create Communication with HubSpot API on New Monitor Run Completed from Postman API

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

Trigger workflow on

New Monitor Run Completed from the Postman API

Next, do this

Create Communication 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 Postman 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 Monitor Run Completed trigger
1. Connect your Postman account
2. Configure timer
3. Select a Monitor ID
Configure the Create Communication action
1. Connect your HubSpot account
2. Optional- Select a Associated Object Type
3. Optional- Select a Associated Object
4. Optional- Select a Association Type
5. Configure Object Properties
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 Monitor Run Completed on Postman

Description:Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)

Version:0.0.1

Key:postman-monitor-run-completed

View on GitHub

Postman Overview#

The Postman API enables you to automate tasks within your Postman collections, such as running collections, fetching and updating environments, and integrating your API development workflow into your CI/CD pipeline. Using Pipedream, you can harness this functionality to create custom workflows that trigger on various events, process data, and connect with other apps, extending the capabilities of your API testing and development processes.

Trigger Code#

import postman from "../../postman.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "postman-monitor-run-completed",
  name: "New Monitor Run Completed",
  description: "Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    postman,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60,
      },
    },
    monitorId: {
      propDefinition: [
        postman,
        "monitorId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || new Date("1970-01-01");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent() {
      const lastDate = this._getLastDate();

      const { monitor } = await this.postman.getMonitor({
        monitorId: this.monitorId,
      });

      if (monitor.lastRun?.status === "success" && new Date(monitor.lastRun.startedAt) > new Date(lastDate)) {
        this._setLastDate(monitor.lastRun.startedAt);
        this.emitEvent(monitor);
      }
    },
    emitEvent(monitor) {
      this.$emit(monitor, {
        id: monitor.id + monitor.lastRun.startedAt,
        summary: `Monitor Run Completed: ${monitor.name}`,
        ts: Date.parse(monitor.lastRun.finishedAt),
      });
    },
  },
  async run() {
    await this.startEvent();
  },
  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
Postman	`postman`	`app`	This component uses the Postman app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Monitor ID	`monitorId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API key,

Navigate to your Postman account and sign in
Go to your Integration Dashboard
Click "Generate API Key", and copy and paste it below.

About Postman#

Postman is the world's leading API platform.

Action#

Create Communication on HubSpot

Description:Create a WhatsApp, LinkedIn, or SMS message. [See the documentation](https://developers.hubspot.com/beta-docs/reference/api/crm/engagements/communications/v3#post-%2Fcrm%2Fv3%2Fobjects%2Fcommunications)

Version:0.0.4

Key:hubspot-create-communication

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 appProp from "../common/common-app-prop.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { ASSOCIATION_CATEGORY } from "../../common/constants.mjs";

export default {
  ...common,
  key: "hubspot-create-communication",
  name: "Create Communication",
  description: "Create a WhatsApp, LinkedIn, or SMS message. [See the documentation](https://developers.hubspot.com/beta-docs/reference/api/crm/engagements/communications/v3#post-%2Fcrm%2Fv3%2Fobjects%2Fcommunications)",
  version: "0.0.4",
  type: "action",
  props: {
    ...appProp.props,
    toObjectType: {
      propDefinition: [
        appProp.props.hubspot,
        "objectType",
      ],
      label: "Associated Object Type",
      description: "Type of object the communication is being associated with",
      optional: true,
    },
    toObjectId: {
      propDefinition: [
        appProp.props.hubspot,
        "objectId",
        (c) => ({
          objectType: c.toObjectType,
        }),
      ],
      label: "Associated Object",
      description: "ID of object the communication is being associated with",
      optional: true,
    },
    associationType: {
      propDefinition: [
        appProp.props.hubspot,
        "associationType",
        (c) => ({
          fromObjectType: "communications",
          toObjectType: c.toObjectType,
        }),
      ],
      description: "A unique identifier to indicate the association type between the communication and the other object",
      optional: true,
    },
    objectProperties: {
      type: "object",
      label: "Object Properties",
      description: "Enter the `communication` properties as a JSON object",
    },
  },
  methods: {
    ...common.methods,
    getObjectType() {
      return "communications";
    },
  },
  async run({ $ }) {
    const {
      hubspot,
      /* eslint-disable no-unused-vars */
      toObjectType,
      toObjectId,
      associationType,
      getObjectType,
      objectProperties,
      ...otherProperties
    } = this;

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

    const properties = objectProperties
      ? typeof objectProperties === "string"
        ? JSON.parse(objectProperties)
        : objectProperties
      : otherProperties;

    const response = await hubspot.createObject({
      $,
      objectType: getObjectType(),
      data: {
        associations: toObjectId
          ? [
            {
              types: [
                {
                  associationTypeId: associationType,
                  associationCategory: ASSOCIATION_CATEGORY.HUBSPOT_DEFINED,
                },
              ],
              to: {
                id: toObjectId,
              },
            },
          ]
          : undefined,
        properties: {
          ...properties,
          hs_communication_logged_from: "CRM",
        },
      },
    });

    $.export("$summary", `Successfully created communication with ID ${response.id}`);
    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
HubSpot	`hubspot`	`app`	This component uses the HubSpot app.
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.
Object Properties	`objectProperties`	`object`	Enter the `communication` properties as a JSON object

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 Communication with HubSpot API on New Monitor Run Completed from Postman API

Pipedream makes it easy to connect APIs for HubSpot, Postman 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