View as Markdown
Heartbeat icon

Heartbeat ACTION

Send Direct Message

Send a direct message in Heartbeat. 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 Send Direct Message 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-send-direct-message",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    heartbeat: { authProvisionId: "apn_xxxxxxx" },
    text: "Text",
    to: "To",
  },
})

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.

Send Direct Message inputs
Property Type Description
text Text string
See the Rich Text page to learn more about formatting
Required
to To string
The user ID of the receiver
Required Dynamic
from From string
The user ID of the sender. Only an admin user can be chosen. If this field is not provided, the user that created the API key will be used
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
heartbeat-send-direct-message
Version
0.0.1
App
Heartbeat
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes