Create Contact with Endorsal API on New or Updated Deal from HubSpot API

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

Trigger workflow on

New or Updated Deal from the HubSpot API

Next, do this

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

Select this integration
Configure the New or Updated Deal trigger
1. Connect your HubSpot account
2. Configure timer
3. Configure info
4. Optional- Select one or more Additional properties to retrieve
5. Optional- Select a Pipeline
6. Optional- Select a Stage
7. Optional- Configure New Only
Configure the Create Contact action
1. Connect your Endorsal account
2. Select a Campaign ID
3. Optional- Configure Name
4. Optional- Configure Email
5. Optional- Configure Phone
6. Optional- Configure Avatar
7. Optional- Configure Location
8. Optional- Configure Position
9. Optional- Configure Company
10. Optional- Configure Website
11. Optional- Configure External ID
12. Optional- Configure Imported From
13. Optional- Configure Custom Attributes
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 or Updated Deal on HubSpot

Description:Emit new event for each new or updated deal in Hubspot

Version:0.0.3

Key:hubspot-new-or-updated-deal

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 common from "../common/common.mjs";
import {
  DEFAULT_LIMIT, DEFAULT_DEAL_PROPERTIES,
} from "../../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "hubspot-new-or-updated-deal",
  name: "New or Updated Deal",
  description: "Emit new event for each new or updated deal in Hubspot",
  version: "0.0.3",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    info: {
      type: "alert",
      alertType: "info",
      content: `Properties:\n\`${DEFAULT_DEAL_PROPERTIES.join(", ")}\``,
    },
    properties: {
      propDefinition: [
        common.props.hubspot,
        "dealProperties",
        () => ({
          excludeDefaultProperties: true,
        }),
      ],
      label: "Additional properties to retrieve",
    },
    pipeline: {
      propDefinition: [
        common.props.hubspot,
        "dealPipeline",
      ],
      description: "Filter deals by pipeline",
      optional: true,
    },
    stage: {
      propDefinition: [
        common.props.hubspot,
        "stages",
        (c) => ({
          pipeline: c.pipeline,
        }),
      ],
      type: "string",
      label: "Stage",
      description: "Filter deals by stage",
      optional: true,
    },
    newOnly: {
      type: "boolean",
      label: "New Only",
      description: "Emit events only for new deals",
      default: false,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getTs(deal) {
      return this.newOnly
        ? Date.parse(deal.createdAt)
        : Date.parse(deal.updatedAt);
    },
    generateMeta(deal) {
      const {
        id,
        properties,
      } = deal;
      const ts = this.getTs(deal);
      return {
        id: this.newOnly
          ? id
          : `${id}-${ts}`,
        summary: properties.dealname,
        ts,
      };
    },
    isRelevant(deal, updatedAfter) {
      return this.getTs(deal) > updatedAfter;
    },
    getParams() {
      const { properties = [] } = this;
      const params = {
        data: {
          limit: DEFAULT_LIMIT,
          sorts: [
            {
              propertyName: "hs_lastmodifieddate",
              direction: "DESCENDING",
            },
          ],
          properties: [
            ...DEFAULT_DEAL_PROPERTIES,
            ...properties,
          ],
        },
        object: "deals",
      };
      if (this.pipeline) {
        params.data.filters = [
          {
            propertyName: "pipeline",
            operator: "EQ",
            value: this.pipeline,
          },
        ];
        if (this.stage) {
          params.data.filters.push({
            propertyName: "dealstage",
            operator: "EQ",
            value: this.stage,
          });
        }
      }
      return params;
    },
    async processResults(after, params) {
      await this.searchCRM(params, 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`
Additional properties to retrieve	`properties`	`string[]`	Select a value from the drop down menu.
Pipeline	`pipeline`	`string`	Select a value from the drop down menu.
Stage	`stage`	`string`	Select a value from the drop down menu.
New Only	`newOnly`	`boolean`	Emit events only for new deals

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.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

About HubSpot#

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

Action#

Create Contact on Endorsal

Description:Creates a new contact for requesting testimonials. [See the documentation](https://developers.endorsal.io/docs/endorsal/b3a6mtczmzu5na-create-a-new-contact)

Version:0.0.1

Key:endorsal-create-contact

View on GitHub

Endorsal Overview#

The Endorsal API provides a way to programmatically manage and showcase customer testimonials. With Pipedream, you can automate the collection and display of endorsements, sync these testimonials with other marketing tools, and trigger actions based on new reviews. This seamless integration enables you to leverage customer feedback effectively to boost your brand's credibility and visibility.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObj } from "../../common/utils.mjs";
import endorsal from "../../endorsal.app.mjs";

export default {
  key: "endorsal-create-contact",
  name: "Create Contact",
  description: "Creates a new contact for requesting testimonials. [See the documentation](https://developers.endorsal.io/docs/endorsal/b3a6mtczmzu5na-create-a-new-contact)",
  version: "0.0.1",
  type: "action",
  props: {
    endorsal,
    campaignID: {
      propDefinition: [
        endorsal,
        "campaignID",
      ],
    },
    name: {
      propDefinition: [
        endorsal,
        "name",
      ],
      optional: true,
    },
    email: {
      propDefinition: [
        endorsal,
        "email",
      ],
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The phone of the contact. `Email` OR `Phone` is required.",
      optional: true,
    },
    avatar: {
      propDefinition: [
        endorsal,
        "avatar",
      ],
      optional: true,
    },
    location: {
      propDefinition: [
        endorsal,
        "location",
      ],
      optional: true,
    },
    position: {
      propDefinition: [
        endorsal,
        "position",
      ],
      optional: true,
    },
    company: {
      propDefinition: [
        endorsal,
        "company",
      ],
      optional: true,
    },
    website: {
      type: "string",
      label: "Website",
      description: "The website of the contact.",
      optional: true,
    },
    externalID: {
      type: "string",
      label: "External ID",
      description: "ID from platform from which contact was imported.",
      optional: true,
    },
    importedFrom: {
      type: "string",
      label: "Imported From",
      description: "Name of platform from which contact was imported.",
      optional: true,
    },
    customAttributes: {
      type: "object",
      label: "Custom Attributes",
      description: "Custom key/value pairs.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      endorsal,
      campaignID,
      email,
      phone,
      customAttributes,
      ...data
    } = this;

    if (!email && !phone) {
      throw new ConfigurationError("You must provide either **Email** or **Phone**.");
    }

    const response = await endorsal.createContact({
      params: {
        campaignID,
      },
      data: {
        email,
        phone,
        customAttributes: parseObj(customAttributes),
        ...data,
      },
    });

    $.export("$summary", `Successfully created contact with ID: ${response.data?._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
Endorsal	`endorsal`	`app`	This component uses the Endorsal app.
Campaign ID	`campaignID`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the contact.
Email	`email`	`string`	The email of the contact. `Email` OR `Phone` is required.
Phone	`phone`	`string`	The phone of the contact. `Email` OR `Phone` is required.
Avatar	`avatar`	`string`	URL to the image.
Location	`location`	`string`	The location of the contact.
Position	`position`	`string`	The position of the contact in the company.
Company	`company`	`string`	The company of the contact.
Website	`website`	`string`	The website of the contact.
External ID	`externalID`	`string`	ID from platform from which contact was imported.
Imported From	`importedFrom`	`string`	Name of platform from which contact was imported.
Custom Attributes	`customAttributes`	`object`	Custom key/value pairs.

Action Authentication#

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

To retrieve your API keys,

Navigate to your Endorsal account and sign in
Go to “Account Details” > “API”

Create Contact with Endorsal API on New or Updated Deal from HubSpot API

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