Batch Create or Update Contact with HubSpot API on New Document Parsing Completed (Instant) from Cradl AI API

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

Trigger workflow on

New Document Parsing Completed (Instant) from the Cradl AI 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 Cradl AI 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 Document Parsing Completed (Instant) trigger
1. Connect your Cradl AI account
2. Configure timer
3. Select a Workflow ID
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#

New Document Parsing Completed (Instant) on Cradl AI

Description:Emit new event when a document processing flow has completed.

Version:0.0.1

Key:cradl_ai-new-document-parsing-completed-instant

View on GitHub

Cradl AI Overview#

Cradl AI is a powerful tool for creating customized machine learning models without extensive coding knowledge. It specializes in processing and understanding various forms of data, including text and images. Utilizing the Cradl AI API on Pipedream, developers can automate workflows involving data analysis, enhance data-driven decision-making, and integrate AI capabilities into applications seamlessly. This opens up opportunities for dynamic interactions with other services, streamlining operations and enhancing user experiences.

Trigger Code#

import cradlAi from "../../cradl_ai.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "cradl_ai-new-document-parsing-completed-instant",
  name: "New Document Parsing Completed (Instant)",
  description: "Emit new event when a document processing flow has completed.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    cradlAi,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    workflowId: {
      propDefinition: [
        cradlAi,
        "workflowId",
      ],
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs") || 0;
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    emitEvent(item) {
      const meta = this.generateMeta(item);
      this.$emit(item, meta);
    },
    generateMeta(item) {
      return {
        id: item.executionId,
        summary: `Execution completed with ID ${item.executionId}`,
        ts: Date.parse(item.endTime),
      };
    },
    async processEvent(max) {
      const lastTs = this._getLastTs();
      const results = this.cradlAi.paginate({
        resourceFn: this.cradlAi.listExecutions,
        args: {
          workflowId: this.workflowId,
          params: {
            order: "descending",
            sortBy: "endTime",
            status: [
              "completed",
            ],
          },
        },
        resourceType: "executions",
        max,
      });
      const executions = [];
      for await (const item of results) {
        const ts = Date.parse(item.endTime);
        if (ts >= lastTs) {
          executions.push(item);
        } else {
          break;
        }
      }
      if (!executions.length) {
        return;
      }
      this._setLastTs(Date.parse(executions[0].endTime));
      executions.reverse().forEach((item) => this.emitEvent(item));
    },
  },
  async run() {
    await this.processEvent();
  },
};

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
Cradl AI	`cradlAi`	`app`	This component uses the Cradl AI app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Workflow ID	`workflowId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Cradl AI uses OAuth authentication. When you connect your Cradl AI account, Pipedream will open a popup window where you can sign into Cradl AI and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Cradl AI API.

Pipedream requests the following authorization scopes when you connect your account:

api.lucidtech.ai/users:read

About Cradl AI#

Automate internal document processes with AI.

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 New Document Parsing Completed (Instant) from Cradl AI API

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