Create Associations with HubSpot API on New Contact Created from Campayn API

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

Trigger workflow on

New Contact Created from the Campayn API

Next, do this

Create Associations 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 Campayn 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 Contact Created trigger
1. Connect your Campayn account
2. Configure timer
3. Select a List
Configure the Create Associations action
1. Connect your HubSpot account
2. Select a From Object Type
3. Select a From Object
4. Select a To Object Type
5. Select a Association Type
6. Select one or more To Objects
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 Created on Campayn

Description:Emit new events when a new contact is created. [See the docs](https://github.com/nebojsac/Campayn-API/blob/master/endpoints/contacts.md#get-contacts)

Version:0.0.1

Key:campayn-new-contact-created

View on GitHub

Campayn Overview#

The Campayn API lets you automate email marketing tasks directly within Pipedream. It provides programmatic access to manage contacts, lists, and email campaigns. With Pipedream, you can build serverless workflows to integrate Campayn with other apps and services, triggering actions based on events, scheduling regular email campaigns, or syncing data across platforms.

Trigger Code#

import common from "../common/common.mjs";

export default {
  ...common,
  key: "campayn-new-contact-created",
  name: "New Contact Created",
  description: "Emit new events when a new contact is created. [See the docs](https://github.com/nebojsac/Campayn-API/blob/master/endpoints/contacts.md#get-contacts)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    listId: {
      propDefinition: [
        common.props.campayn,
        "listId",
      ],
    },
  },
  methods: {
    ...common.methods,
    async getResources() {
      return this.campayn.listContacts(this.listId);
    },
    generateMeta(contact) {
      return {
        id: contact.id,
        summary: contact.email,
        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
Campayn	`campayn`	`app`	This component uses the Campayn app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
List	`listId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To get your API Key, sign in to your Campayn dashboard then click on Settings in the left menu. The API Key is displayed inside the Account page.

About Campayn#

Campayn.com is the easiest way to create, send and track email marketing campaigns.

Action#

Create Associations on HubSpot

Description:Create associations between objects. [See the documentation](https://developers.hubspot.com/docs/api/crm/associations#endpoint?spec=POST-/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create)

Version:0.0.11

Key:hubspot-create-associations

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 hubspot from "../../hubspot.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "hubspot-create-associations",
  name: "Create Associations",
  description: "Create associations between objects. [See the documentation](https://developers.hubspot.com/docs/api/crm/associations#endpoint?spec=POST-/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create)",
  version: "0.0.11",
  type: "action",
  props: {
    hubspot,
    fromObjectType: {
      propDefinition: [
        hubspot,
        "objectType",
        () => ({
          includeCustom: true,
        }),
      ],
      label: "From Object Type",
      description: "The type of the object being associated",
    },
    fromObjectId: {
      propDefinition: [
        hubspot,
        "objectIds",
        (configuredProps) => ({
          objectType: configuredProps.fromObjectType,
        }),
      ],
      type: "string",
      label: "From Object",
      description: "The ID of the object being associated",
    },
    toObjectType: {
      propDefinition: [
        hubspot,
        "objectType",
        () => ({
          includeCustom: true,
        }),
      ],
      label: "To Object Type",
      description: "Type of the objects the from object is being associated with",
    },
    associationType: {
      propDefinition: [
        hubspot,
        "associationType",
        (configuredProps) => ({
          fromObjectType: configuredProps.fromObjectType,
          toObjectType: configuredProps.toObjectType,
        }),
      ],
    },
    toObjectIds: {
      propDefinition: [
        hubspot,
        "objectIds",
        (configuredProps) => ({
          objectType: configuredProps.toObjectType,
        }),
      ],
      label: "To Objects",
      description: "Id's of the objects the from object is being associated with",
    },
  },
  methods: {
    async getAssociationCategory({
      $, fromObjectType, toObjectType, associationType,
    }) {
      const { results } = await this.hubspot.getAssociationTypes({
        $,
        fromObjectType,
        toObjectType,
        associationType,
      });
      const association = results.find(({ typeId }) => typeId === this.associationType);
      return association.category;
    },
  },
  async run({ $ }) {
    const {
      fromObjectType,
      fromObjectId,
      toObjectType,
      associationType,
    } = this;
    let toObjectIds;
    if (Array.isArray(this.toObjectIds)) {
      toObjectIds = this.toObjectIds;
    } else {
      try {
        toObjectIds = JSON.parse(this.toObjectIds);
      } catch {
        throw new ConfigurationError("Could not parse \"To Objects\" array.");
      }
    }

    const associationCategory = await this.getAssociationCategory({
      $,
      fromObjectType,
      toObjectType,
      associationType,
    });
    const response = await this.hubspot.createAssociations({
      $,
      fromObjectType,
      toObjectType,
      data: {
        inputs: toObjectIds.map((toId) => ({
          from: {
            id: fromObjectId,
          },
          to: {
            id: toId,
          },
          types: [
            {
              associationCategory,
              associationTypeId: associationType,
            },
          ],
        })),
      },
    });
    const l = response.results.length;
    $.export("$summary", `Successfully created ${l} association${l === 1
      ? ""
      : "s"}`);
    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.
From Object Type	`fromObjectType`	`string`	Select a value from the drop down menu.
From Object	`fromObjectId`	`string`	Select a value from the drop down menu.
To Object Type	`toObjectType`	`string`	Select a value from the drop down menu.
Association Type	`associationType`	`string`	Select a value from the drop down menu.
To Objects	`toObjectIds`	`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 Associations with HubSpot API on New Contact Created from Campayn API

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