Create Engagement with HubSpot API on New Session Started from Sessions API

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

Trigger workflow on

New Session Started from the Sessions 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 Sessions 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 Session Started trigger
1. Connect your Sessions 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
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 Session Started on Sessions

Description:Emit new an event when a session starts. [See the documentation](https://api.app.sessions.us/api-docs/#/default/get_api_sessions)

Version:0.0.1

Key:sessions-new-session-started

View on GitHub

Sessions Overview#

The Sessions API enables developers to handle real-time data streams and manage user sessions effectively. With Pipedream's power to integrate various services, the Sessions API can be the backbone of workflows that require managing user states across events. You can track user activities, tailor user experiences based on session data, or even trigger specific actions when certain session events occur.

Trigger Code#

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

export default {
  ...common,
  key: "sessions-new-session-started",
  name: "New Session Started",
  description: "Emit new an event when a session starts. [See the documentation](https://api.app.sessions.us/api-docs/#/default/get_api_sessions)",
  version: "0.0.1",
  type: "source",
  methods: {
    ...common.methods,
    emitEvent(data) {
      this._setLastResourceId(data.id);

      this.$emit(data, {
        id: data.id,
        summary: `New session started with id ${data.id}`,
        ts: Date.parse(data.startAt),
      });
    },
    async getResources(args = {}) {
      return this.sessions.getSessions(args);
    },
  },
};

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

Trigger Authentication#

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

About Sessions#

Run online meetings and webinars like a pro.

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

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.11",
  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,
    },
  },
  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,
      ...properties
    } = this;

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

    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.

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 Session Started from Sessions API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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