Create Engagement with HubSpot API on New Appointment (Instant) from Acuity Scheduling API

Pipedream makes it easy to connect APIs for HubSpot, Acuity Scheduling and 2,900+ other apps remarkably fast.

Trigger workflow on

New Appointment (Instant) from the Acuity Scheduling 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 Acuity Scheduling 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 Appointment (Instant) trigger
1. Connect your Acuity Scheduling account
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 Appointment (Instant) on Acuity Scheduling

Description:Emit new event when an appointment is scheduled.

Version:0.0.3

Key:acuity_scheduling-new-appointment-instant

View on GitHub

Acuity Scheduling Overview#

Acuity Scheduling API allows you to tap into the functionality of Acuity Scheduling, a cloud-based appointment scheduling software. With this API on Pipedream, you can automate appointment creation, modifications, and cancellations, as well as sync customer data across your tech stack. The API lets you fetch detailed information about schedules, available time slots, and calendar events. Create dynamic, real-time integrations with CRMs, email marketing platforms, or payment gateways to streamline your scheduling and business processes.

Trigger Code#

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

export default {
  ...common,
  key: "acuity_scheduling-new-appointment-instant",
  name: "New Appointment (Instant)",
  description: "Emit new event when an appointment is scheduled.",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvent() {
      return "appointment.scheduled";
    },
    getSummary(details) {
      return `New appointment scheduled with Id: ${details.id}`;
    },
  },
  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
Acuity Scheduling	`acuityScheduling`	`app`	This component uses the Acuity Scheduling 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.

Trigger Authentication#

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

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

api-v1

About Acuity Scheduling#

Online Appointment Scheduling

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.30

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 { ConfigurationError } from "@pipedream/platform";
import {
  ASSOCIATION_CATEGORY,
  ENGAGEMENT_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import common from "../common/common-create.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.30",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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`	`integer`	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.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.objects.listings.writecrm.objects.listings.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.quotes.readcrm.schemas.listings.writecrm.schemas.listings.readcrm.importfilesformsforms-uploaded-filesoauthtimelineintegration-synccrm.schemas.deals.writecrm.lists.writeconversations.read

About HubSpot#

HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.

More Ways to Connect HubSpot + Acuity Scheduling#

Other Popular Integrations#

Add Contact to List with HubSpot API on New Appointment (Instant) from Acuity Scheduling API

Acuity Scheduling + HubSpot

Create Engagement with HubSpot API on New Appointment (Instant) from Acuity Scheduling API

Pipedream makes it easy to connect APIs for HubSpot, Acuity Scheduling and 2,900+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular