Initiate Survey with Pidj API on New Contact in List from HubSpot API

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

Trigger workflow on

New Contact in List from the HubSpot API

Next, do this

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

Select this integration
Configure the New Contact in List trigger
1. Connect your HubSpot account
2. Configure timer
3. Select one or more Lists
4. Optional- Select one or more Contact Properties
Configure the Initiate Survey action
1. Connect your Pidj account
2. Select a Survey ID
3. Select a Contact ID
4. Optional- Configure From Number
5. Optional- Select a Group 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 Contact in List on HubSpot

Description:Emit new event for each new contact in a list.

Version:0.1.1

Key:hubspot-new-contact-in-list

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";

export default {
  ...common,
  key: "hubspot-new-contact-in-list",
  name: "New Contact in List",
  description: "Emit new event for each new contact in a list.",
  version: "0.1.1",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    lists: {
      propDefinition: [
        common.props.hubspot,
        "lists",
      ],
    },
    properties: {
      propDefinition: [
        common.props.hubspot,
        "contactProperties",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(contact, list) {
      const {
        vid,
        properties,
      } = contact;
      const {
        value,
        label,
      } = list;
      return {
        id: `${vid}${value}`,
        summary: `${properties?.firstname?.value} ${properties?.lastname?.value} added to ${label}`,
        ts: Date.now(),
      };
    },
    async emitEvent(contact, properties, list) {
      const contactInfo = await this.hubspot.getContact(
        contact.vid,
        properties,
      );
      const meta = this.generateMeta(contact, list);
      this.$emit({
        contact,
        contactInfo,
      }, meta);
    },
    getParams() {
      return {
        count: 100,
      };
    },
    async processResults() {
      const properties = this.properties;
      for (let list of this.lists) {
        const params = this.getParams();
        let hasMore = true;
        while (hasMore) {
          const results = await this.hubspot.getListContacts(params, list.value);
          hasMore = results["has-more"];
          if (hasMore) params.vidOffset = results["vid-offset"];
          for (const contact of results.contacts) {
            await this.emitEvent(contact, properties, list);
          }
        }
      }
    },
  },
};

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`
Lists	`lists`	`string[]`	Select a value from the drop down menu.
Contact Properties	`properties`	`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.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#

Initiate Survey on Pidj

Description:Triggers a pre-configured text survey to a specific contact. Requires the contact's information and the survey ID. [See the documentation](https://pidj.co/wp-content/uploads/2023/06/Pidj-API-Technical-Document-v3-1.pdf).

Version:0.0.1

Key:pidj-initiate-survey

View on GitHub

Pidj Overview#

The Pidj API allows users to manage and automate SMS communication directly through their platform. Integrating Pidj with Pipedream offers a powerful way to streamline communications, synchronize data across apps, and trigger SMS actions based on specific conditions. With Pipedream, you can effortlessly connect Pidj to other apps, creating sophisticated, multi-step workflows that react in real-time to events across your software stack.

Action Code#

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

export default {
  key: "pidj-initiate-survey",
  name: "Initiate Survey",
  description: "Triggers a pre-configured text survey to a specific contact. Requires the contact's information and the survey ID. [See the documentation](https://pidj.co/wp-content/uploads/2023/06/Pidj-API-Technical-Document-v3-1.pdf).",
  version: "0.0.1",
  type: "action",
  props: {
    pidj,
    surveyId: {
      propDefinition: [
        pidj,
        "surveyId",
      ],
    },
    contactId: {
      propDefinition: [
        pidj,
        "contactId",
      ],
    },
    fromNumber: {
      propDefinition: [
        pidj,
        "fromNumber",
      ],
      optional: true,
    },
    groupId: {
      propDefinition: [
        pidj,
        "groupId",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if ((!this.fromNumber && !this.groupId) || (this.fromNumber && this.groupId)) {
      throw new ConfigurationError("You must provide either From Number or Group Id.");
    }

    const response = await this.pidj.triggerSurvey({
      $,
      data: {
        survey_id: this.surveyId,
        contact_id: this.contactId,
        from_number: this.fromNumber,
        group_id: this.groupId,
      },
    });

    $.export("$summary", `Successfully initiated survey for contact ${this.contactId}`);
    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
Pidj	`pidj`	`app`	This component uses the Pidj app.
Survey ID	`surveyId`	`string`	Select a value from the drop down menu.
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
From Number	`fromNumber`	`string`	Phone number to send from; this will determine which group the message sends from, and must be an active number from one of your groups. This must be in E.164 format, e.g., +18885552222
Group Id	`groupId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your Account Key and Token,

Navigate to your Pidj account and sign in
Click the workspace menu on the top right
Go to "APIs".

Initiate Survey with Pidj API on New Contact in List from HubSpot API

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