Batch Create or Update Contact with HubSpot API on Job Run Completed (Instant) from dbt Cloud API

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

Trigger workflow on

Job Run Completed (Instant) from the dbt Cloud API

Next, do this

Batch Create or Update Contact 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 dbt Cloud 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 Job Run Completed (Instant) trigger
1. Connect your dbt Cloud account
2. Select a Account
Configure the Batch Create or Update Contact action
1. Connect your HubSpot account
2. Configure Contacts Array
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#

Job Run Completed (Instant) on dbt Cloud

Description:Emit new event when a job run has completed.

Version:0.0.2

Key:dbt-job-run-completed

View on GitHub

dbt Cloud Overview#

The dbt Cloud API allows users to initiate jobs, check on their status, and interact with dbt Cloud programmatically. On Pipedream, you can harness this functionality to automate workflows, such as triggering dbt runs, monitoring your data transformation jobs, and integrating dbt Cloud with other data services. By leveraging Pipedream's serverless platform, you can create custom workflows that act on dbt Cloud events or use the dbt Cloud API to manage your data transformation processes seamlessly.

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "dbt-job-run-completed",
  name: "Job Run Completed (Instant)",
  description: "Emit new event when a job run has completed.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventTypes() {
      return [
        "job.run.completed",
      ];
    },
    generateMeta(body) {
      return {
        id: body.eventId,
        summary: `Job "${body.data.jobName}"" completed`,
        ts: Date.parse(body.data.runFinishedAt),
      };
    },
  },
  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
dbt Cloud	`dbt`	`app`	This component uses the dbt Cloud 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.
Account	`accountId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About dbt Cloud#

dbt is an intuitive, collaborative platform that lets you reliably transform data using SQL and Python code.

Action#

Batch Create or Update Contact on HubSpot

Description:Create or update a batch of contacts by its ID or email. [See the documentation](https://developers.hubspot.com/docs/api/crm/contacts)

Version:0.0.8

Key:hubspot-batch-create-or-update-contact

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

export default {
  key: "hubspot-batch-create-or-update-contact",
  name: "Batch Create or Update Contact",
  description: "Create or update a batch of contacts by its ID or email. [See the documentation](https://developers.hubspot.com/docs/api/crm/contacts)",
  version: "0.0.8",
  type: "action",
  props: {
    hubspot,
    contacts: {
      label: "Contacts Array",
      description: "Provide a **list of contacts** to be created or updated. If the provided contact has the prop ID or if the provided email already exists, this action will attempt to update it.\n\n**Expected format for create:** `{ \"company\": \"Biglytics\", \"email\": \"bcooper@biglytics.net\", \"firstname\": \"Bryan\", \"lastname\": \"Cooper\", \"phone\": \"(877) 929-0687\", \"website\": \"biglytics.net\" }` \n\n**Expected format for update:** `{ \"id\": \"101\", \"company\": \"Biglytics\", \"email\": \"bcooper@biglytics.net\", \"firstname\": \"Bryan\", \"lastname\": \"Cooper\", \"phone\": \"(877) 929-0687\", \"website\": \"biglytics.net\" }`",
      type: "string[]",
    },
  },
  methods: {
    parseContactArray(contacts) {
      if (typeof (contacts) === "string") {
        contacts = JSON.parse(contacts);
      }
      else if (Array.isArray(contacts) && contacts.length > 0 && typeof (contacts[0]) === "string") {
        contacts = contacts.map((contact) => JSON.parse(contact));
      }
      return contacts;
    },
    async searchExistingContactProperties(contacts, $) {
      const emails = contacts.map(({ email }) => email);
      const { results } = await this.hubspot.searchCRM({
        $,
        object: "contact",
        data: {
          filters: [
            {
              propertyName: "email",
              operator: "IN",
              values: emails,
            },
          ],
        },
      });
      const updateEmails = results?.map(({ properties }) => properties.email);
      const insertProperties = contacts.filter(({ email }) => !updateEmails.includes(email))
        .map((properties) => ({
          properties,
        }));
      const updateProperties = [];
      for (const contact of results) {
        updateProperties.push({
          id: contact.id,
          properties: contacts.find(({ email }) => contact.properties.email === email),
        });
      }
      return {
        insertProperties,
        updateProperties,
      };
    },
  },
  async run({ $ }) {
    const contacts = this.parseContactArray(this.contacts);

    const {
      insertProperties, updateProperties,
    } = await this.searchExistingContactProperties(contacts, $);

    const updatePropertiesWithId = contacts.filter((contact) => (Object.prototype.hasOwnProperty.call(contact, "id")))
      .map(({
        id, ...properties
      }) => ({
        id: id,
        properties,
      }));

    if (updatePropertiesWithId?.length) {
      updateProperties.push(...updatePropertiesWithId);
    }

    let response = {};
    response.created = await this.hubspot.batchCreateContacts({
      $,
      data: {
        inputs: insertProperties,
      },
    });
    response.updated = await this.hubspot.batchUpdateContacts({
      $,
      data: {
        inputs: updateProperties,
      },
    });

    $.export("$summary", `Successfully created ${insertProperties.length} and updated ${updateProperties.length} contacts`);

    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.
Contacts Array	`contacts`	`string[]`	Provide a list of contacts to be created or updated. If the provided contact has the prop ID or if the provided email already exists, this action will attempt to update it. Expected format for create: `{ "company": "Biglytics", "email": "bcooper@biglytics.net", "firstname": "Bryan", "lastname": "Cooper", "phone": "(877) 929-0687", "website": "biglytics.net" }` Expected format for update: `{ "id": "101", "company": "Biglytics", "email": "bcooper@biglytics.net", "firstname": "Bryan", "lastname": "Cooper", "phone": "(877) 929-0687", "website": "biglytics.net" }`

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

Batch Create or Update Contact with HubSpot API on Job Run Completed (Instant) from dbt Cloud API

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