CONNECT APP
Build with Heartbeat
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"],
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"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",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Add To Group:
result = await session.call_tool("heartbeat-add-to-group", {
"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.# 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"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"],
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="heartbeat-add-to-group",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"heartbeat": {"authProvisionId": "apn_xxxxxxx"},
"groupID": "Group ID",
"emails": ["Emails"],
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "heartbeat-add-to-group",
"configured_props": {
"heartbeat": { "authProvisionId": "apn_xxxxxxx" },
"groupID": "Group ID",
"emails": ["Emails"]
}
}'TOOLS
Heartbeat actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Add To Group
actionAdd user(s) to a Heartbeat group. See the documentationWritev0.0.1 -
Create Event
actionCreate a new Event in a Heartbeat community. See the documentationWritev0.0.1 -
List Emails Options
actionRetrieves available options for the Emails field.Read-onlyv0.0.1 -
List Group ID Options
actionRetrieves available options for the Group ID field.Read-onlyv0.0.1 -
Send Direct Message
actionSend a direct message in Heartbeat. See the documentationWritev0.0.1
EVENTS
Heartbeat triggers
Event sources your backend can deploy for users and receive through a webhook.
-
New Event (Instant)
triggerEmit new event when a new event is created. See the documentationInstantv0.0.1 -
New User (Instant)
triggerEmit new event when a new user is created. See the documentationInstantv0.0.1 -
User Updated (Instant)
triggerEmit new event when a user is updated. See the documentationInstantv0.0.1
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.
- App slug
- heartbeat
- Authentication
- API key
- Categories
- Communication
- Actions
- 5
- Triggers
- 3
- API proxy
- Available