Create Communication with HubSpot API on New Event Received (Instant) from Hookdeck API

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

Trigger workflow on

New Event Received (Instant) from the Hookdeck 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 Hookdeck 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 Event Received (Instant) trigger
1. Connect your Hookdeck account
2. Optional- Configure Connection Name
3. Optional- Configure Description
4. Optional- Select a Pre-exisiting Source
5. Optional- Configure New Source
6. Optional- Configure Destination Name
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 Event Received (Instant) on Hookdeck

Description:Emit new event when a new event is received from a HookDeck source.

Version:0.0.2

Key:hookdeck-new-event-received

View on GitHub

Hookdeck Overview#

The Hookdeck API facilitates the management of webhooks, providing reliable webhook delivery, monitoring, and debugging solutions. With this API on Pipedream, you can automate workflows concerning incoming webhook data—transforming, routing, and ensuring they trigger the subsequent actions without fail. This could range from logging data for analysis, conditionally processing and forwarding webhook events to other endpoints, or integrating with third-party services for extended automation.

Trigger Code#

import app from "../../hookdeck.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "hookdeck-new-event-received",
  name: "New Event Received (Instant)",
  description: "Emit new event when a new event is received from a HookDeck source.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    http: "$.interface.http",
    name: {
      type: "string",
      label: "Connection Name",
      description: "The name of the connection.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the connection.",
      optional: true,
    },
    sourceId: {
      propDefinition: [
        app,
        "sourceId",
      ],
      label: "Pre-exisiting Source",
    },
    source: {
      type: "object",
      label: "New Source",
      description: "An object representing the source of the connection. Object must contain at least `name`. Please check the [documentation](https://hookdeck.com/api-ref#create-a-connection) for more information.",
      default: {
        name: "My New Source",
      },
      optional: true,
    },
    destinationName: {
      type: "string",
      label: "Destination Name",
      description: "The destination name that will be created or updated with Pipedream HTTP endpoint for Pipedream source to receive your event. Existing destination with the same name will be overridden with the new HTTP endpoint",
      optional: true,
    },
  },
  hooks: {
    async deploy() {
      if (this.sourceId && this.source) {
        throw new ConfigurationError("Only one of `Source Id` or `Source` may be provided.");
      }
      if (!this.source && !this.sourceId) {
        throw new ConfigurationError("Either `Source Id` or `Source` must be provided.");
      }
    },
    async activate() {
      const { id } = await this.app.createConnection({
        name: this.name || `Pipedream_Connection_${this.getCurrentDateTime()}`,
        description: this.description,
        source_id: this.sourceId,
        source: this.source,
        destination: {
          name: this.destinationName || `Pipedream_Source_${this.getCurrentDateTime()}`,
          url: this.http.endpoint,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const id = this._getHookId();
      if (id) {
        await this.deleteConnection(id);
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    async deleteConnection(id) {
      await this.app._makeHttpRequest({
        method: "DELETE",
        path: `/connections/${id}`,
      });
    },
    getCurrentDateTime() {
      const now = new Date();
      const year = now.getFullYear();
      const month = (now.getMonth() + 1).toString().padStart(2, "0");
      const day = now.getDate().toString()
        .padStart(2, "0");
      const hours = now.getHours().toString()
        .padStart(2, "0");
      const minutes = now.getMinutes().toString()
        .padStart(2, "0");

      return `${year}${month}${day}${hours}${minutes}`;
    },
    generateMeta() {
      return {
        id: Date.now(),
        summary: "New Event Received",
        ts: Date.now(),
      };
    },
  },
  async run(event) {
    const { body } = event;
    const meta = this.generateMeta();
    this.$emit(body, meta);
  },
};

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
Hookdeck	`app`	`app`	This component uses the Hookdeck 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.
Connection Name	`name`	`string`	The name of the connection.
Description	`description`	`string`	The description of the connection.
Pre-exisiting Source	`sourceId`	`string`	Select a value from the drop down menu.
New Source	`source`	`object`	An object representing the source of the connection. Object must contain at least `name`. Please check the documentation for more information.
Destination Name	`destinationName`	`string`	The destination name that will be created or updated with Pipedream HTTP endpoint for Pipedream source to receive your event. Existing destination with the same name will be overridden with the new HTTP endpoint

Trigger Authentication#

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

About Hookdeck#

Never miss a webhook again. Our reliable webhook infrastructure gives you full visibility over your webhooks.

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 Event Received (Instant) from Hookdeck API

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