View as Markdown
Heartbeat icon

Heartbeat ACTION

Add To Group

Add user(s) to a Heartbeat group. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Heartbeat account once, then configure and run Add To Group 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: "heartbeat-add-to-group",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    heartbeat: { authProvisionId: "apn_xxxxxxx" },
    groupID: "Group ID",
    emails: ["Emails"],
  },
})

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.

Add To Group inputs
Property Type Description
groupID Group ID string
The ID of the group
Required Dynamic
emails Emails string[]
The emails of the users that should be added to the group
Required Dynamic
shouldRemoveFromSiblingGroups Should Remove From Sibling Groups boolean
If true, the users will be removed from any other groups that share a parent group with the selected group. Useful when moving users between different stages
Required

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
heartbeat-add-to-group
Version
0.0.1
App
Heartbeat
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes