# Heartbeat — Pipedream Connect

> Plug-and-play online communities.

- API slug: `heartbeat` (use in MCP headers and tool keys)
- Auth: API key (Pipedream-managed)
- Categories: Communication
- Website: https://www.heartbeat.chat/
- This page (HTML): https://pipedream.com/apps/heartbeat
- Tools: 5 actions · 3 triggers

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: heartbeat`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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"],
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a Heartbeat endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://api.heartbeat.chat/v0/users

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuaGVhcnRiZWF0LmNoYXQvdjAvdXNlcnM?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

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

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (5)

### `heartbeat-add-to-group` — Add To Group (Write)

Add user(s) to a Heartbeat group. See the documentation

Full schema: https://pipedream.com/apps/heartbeat/actions/add-to-group.md

### `heartbeat-create-event` — Create Event (Write)

Create a new Event in a Heartbeat community. See the documentation

Full schema: https://pipedream.com/apps/heartbeat/actions/create-event.md

### `heartbeat-list-emails-options` — List Emails Options (Read-only)

Retrieves available options for the Emails field.

Full schema: https://pipedream.com/apps/heartbeat/actions/list-emails-options.md

### `heartbeat-list-group-id-options` — List Group ID Options (Read-only)

Retrieves available options for the Group ID field.

Full schema: https://pipedream.com/apps/heartbeat/actions/list-group-id-options.md

### `heartbeat-send-direct-message` — Send Direct Message (Write)

Send a direct message in Heartbeat. See the documentation

Full schema: https://pipedream.com/apps/heartbeat/actions/send-direct-message.md

## Triggers (3)

### `heartbeat-new-event-instant` — New Event (Instant) (Instant)

Emit new event when a new event is created. See the documentation

Full schema: https://pipedream.com/apps/heartbeat/triggers/new-event-instant.md

### `heartbeat-new-user-instant` — New User (Instant) (Instant)

Emit new event when a new user is created. See the documentation

Full schema: https://pipedream.com/apps/heartbeat/triggers/new-user-instant.md

### `heartbeat-user-updated-instant` — User Updated (Instant) (Instant)

Emit new event when a user is updated. See the documentation

Full schema: https://pipedream.com/apps/heartbeat/triggers/user-updated-instant.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt