Heartbeat icon

CONNECT APP

Build with Heartbeat

Plug-and-play online communities.

Communication

  • API key

MCP

Give your agent Heartbeat tools

Every Heartbeat action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Heartbeat account for each tool call — you store no tokens.

// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": "{project_id}",
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "heartbeat",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Add To Group:
const result = await mcp.callTool({
  name: "heartbeat-add-to-group",
  arguments: {
    groupID: "Group ID",
    emails: ["Emails"],
  },
})

API PROXY

Call the Heartbeat API directly

For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Heartbeat API with the connected user's credentials attached. You store no tokens and write no refresh logic.

const resp = await pd.proxy.get({
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  accountId: "apn_xxxxxxx",
  url: "https://api.heartbeat.chat/v0/users",
})

// Any allowed Heartbeat endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.

SDK

Run Heartbeat actions from your backend

Connect a user's Heartbeat account once, then run Add To Group on their behalf from your own code — TypeScript, Python, or plain HTTP.

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"],
  },
})

MULTI-APP

Use Heartbeat with other popular apps

Most products don't stop at one integration. Pair Heartbeat with the other apps your users rely on, and ship use cases that span both.

REFERENCE

App details

Reference metadata for the Heartbeat connector in the Pipedream registry.

App slug
heartbeat
Authentication
API key
Categories
Communication
Actions
5
Triggers
3
API proxy
Available