View as Markdown
HubSpot icon

HubSpot ACTION

Get Engagements

Retrieves one or more engagements by their IDs. Use this action to fetch details about multiple engagements, such as their types, timestamps, and associated CRM objects. Requires engagement IDs, which you can obtain from the List CRM Objects action. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HubSpot account once, then configure and run Get Engagements from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "hubspot-get-engagements",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    hubspot: { authProvisionId: "apn_xxxxxxx" },
    engagementType: "Engagement Type",
    engagementIds: ["Engagement IDs"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Engagements inputs
Property Type Description
engagementType Engagement Type string
One of: notes, tasks, meetings, emails, or calls. Defines the CRM object type listed and which properties belong in Object Properties.
Required Dynamic
engagementIds Engagement IDs string[]
Array of engagement record IDs to retrieve. Example: ["191980186487", "191980186488"].
Required Dynamic
properties Properties string[]
Property names to include in results. Example: ["hs_note_body"] for notes or ["hs_task_subject", "hs_task_body"] for tasks. Use Search Properties to discover available property names. If not specified, engagement-type defaults should be returned.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
hubspot-get-engagements
Version
0.0.6
App
HubSpot
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes