Create Engagement with HubSpot API on New Supporter Added from Buy Me a Coffee API

Pipedream makes it easy to connect APIs for HubSpot, Buy Me a Coffee and 2,400+ other apps remarkably fast.

Trigger workflow on

New Supporter Added from the Buy Me a Coffee API

Next, do this

Create Engagement 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 Buy Me a Coffee 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 Supporter Added trigger
1. Connect your Buy Me a Coffee account
2. Configure timer
Configure the Create Engagement action
1. Connect your HubSpot account
2. Select a Engagement Type
3. Optional- Select a Associated Object Type
4. Optional- Select a Associated Object
5. Optional- Select a Association Type
6. Configure Object Properties
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 Supporter Added on Buy Me a Coffee

Description:Emit new events when a new supporter was added. [See the docs](https://developers.buymeacoffee.com/#/apireference?id=onetime-supporters-v1supporters)

Version:0.0.3

Key:buy_me_a_coffee-new-supporter-added

View on GitHub

Buy Me a Coffee Overview#

The Buy Me a Coffee API allows creators to interact programmatically with their Buy Me a Coffee account. Through Pipedream, you can automate actions such as thanking supporters, tracking donations, and posting updates. By integrating with other apps, you can extend functionalities, streamline your supporter engagement, and analyze your growth.

Trigger Code#

import { defineSource } from "@pipedream/types";
import common from "../common/common.mjs";
export default defineSource({
    ...common,
    key: "buy_me_a_coffee-new-supporter-added",
    name: "New Supporter Added",
    description: "Emit new events when a new supporter was added. [See the docs](https://developers.buymeacoffee.com/#/apireference?id=onetime-supporters-v1supporters)",
    version: "0.0.3",
    type: "source",
    dedupe: "unique",
    methods: {
        ...common.methods,
        getResourceFn() {
            return this.app.getSupporters;
        },
        compareFn(item) {
            return this.getLastCreatedTime() < new Date(item.support_created_on).getTime();
        },
        getSummary(item) {
            return `New supporter ${item.payer_name} note(${item.support_note})`;
        },
        getTimeKey() {
            return "support_created_on";
        },
        getIdKey() {
            return "support_id";
        },
    },
});

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
Buy Me a Coffee	`app`	`app`	This component uses the Buy Me a Coffee app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

To connect your Buy Me a Coffee account with Pipedream, first sign in to your Buy Me a Coffee developer dashboard.

Generate your API token by clicking on the "generate my token" button
Provide a name for your token and click "generate"
Your token will be displayed -- copy that and paste it below

About Buy Me a Coffee#

A supporter is worth a thousand followers. Accept donations. Start a membership. Sell anything you like. It’s easier than you think.

Action#

Create Engagement on HubSpot

Description:Create a new engagement for a contact. [See the documentation](https://developers.hubspot.com/docs/api/crm/engagements)

Version:0.0.14

Key:hubspot-create-engagement

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 common from "../common/common-create.mjs";
import { ConfigurationError } from "@pipedream/platform";
import {
  ASSOCIATION_CATEGORY, ENGAGEMENT_TYPE_OPTIONS,
} from "../../common/constants.mjs";

export default {
  ...common,
  key: "hubspot-create-engagement",
  name: "Create Engagement",
  description: "Create a new engagement for a contact. [See the documentation](https://developers.hubspot.com/docs/api/crm/engagements)",
  version: "0.0.14",
  type: "action",
  props: {
    ...common.props,
    engagementType: {
      type: "string",
      label: "Engagement Type",
      description: "The type of engagement to create",
      reloadProps: true,
      options: ENGAGEMENT_TYPE_OPTIONS,
    },
    toObjectType: {
      propDefinition: [
        common.props.hubspot,
        "objectType",
      ],
      label: "Associated Object Type",
      description: "Type of object the engagement is being associated with",
      optional: true,
    },
    toObjectId: {
      propDefinition: [
        common.props.hubspot,
        "objectId",
        (c) => ({
          objectType: c.toObjectType,
        }),
      ],
      label: "Associated Object",
      description: "ID of object the engagement is being associated with",
      optional: true,
    },
    associationType: {
      propDefinition: [
        common.props.hubspot,
        "associationType",
        (c) => ({
          fromObjectType: c.engagementType,
          toObjectType: c.toObjectType,
        }),
      ],
      description: "A unique identifier to indicate the association type between the task and the other object",
      optional: true,
    },
    objectProperties: {
      type: "object",
      label: "Object Properties",
      description: "Enter the `engagement` properties as a JSON object",
    },
  },
  methods: {
    ...common.methods,
    getObjectType() {
      return this.engagementType;
    },
    isRelevantProperty(property) {
      return common.methods.isRelevantProperty(property) && !property.name.includes("hs_pipeline");
    },
    createEngagement(objectType, properties, associations, $) {
      return this.hubspot.createObject({
        objectType,
        data: {
          properties,
          associations,
        },
        $,
      });
    },
  },
  async run({ $ }) {
    const {
      hubspot,
      /* eslint-disable no-unused-vars */
      engagementType,
      toObjectType,
      toObjectId,
      associationType,
      $db,
      objectProperties,
      ...otherProperties
    } = this;

    if ((toObjectId && !associationType) || (!toObjectId && associationType)) {
      throw new ConfigurationError("Both `toObjectId` and `associationType` must be entered");
    }

    const properties = objectProperties
      ? typeof objectProperties === "string"
        ? JSON.parse(objectProperties)
        : objectProperties
      : otherProperties;

    const objectType = this.getObjectType();

    const associations = toObjectId
      ? [
        {
          to: {
            id: toObjectId,
          },
          types: [
            {
              associationTypeId: associationType,
              associationCategory: ASSOCIATION_CATEGORY.HUBSPOT_DEFINED,
            },
          ],
        },
      ]
      : undefined;

    if (properties.hs_task_reminders) {
      properties.hs_task_reminders = Date.parse(properties.hs_task_reminders);
    }

    const engagement = await this.createEngagement(objectType, properties, associations, $);

    const objectName = hubspot.getObjectTypeName(objectType);
    $.export("$summary", `Successfully created ${objectName} for the contact`);

    return engagement;
  },
};

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.
Engagement Type	`engagementType`	`string`	Select a value from the drop down menu:`{ "label": "Note", "value": "notes" }{ "label": "Task", "value": "tasks" }{ "label": "Meeting", "value": "meetings" }{ "label": "Email", "value": "emails" }{ "label": "Call", "value": "calls" }`
Associated Object Type	`toObjectType`	`string`	Select a value from the drop down menu.
Associated Object	`toObjectId`	`string`	Select a value from the drop down menu.
Association Type	`associationType`	`string`	Select a value from the drop down menu.
Object Properties	`objectProperties`	`object`	Enter the `engagement` properties as a JSON object

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 Engagement with HubSpot API on New Supporter Added from Buy Me a Coffee API

Pipedream makes it easy to connect APIs for HubSpot, Buy Me a Coffee 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