View as Markdown
Project Broadcast icon

Project Broadcast ACTION

Broadcast Message

Sends a broadcast message to a list of contacts. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Project Broadcast account once, then configure and run Broadcast 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: "project_broadcast-broadcast-message",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    project_broadcast: { authProvisionId: "apn_xxxxxxx" },
    scheduledAt: "Scheduled At",
    text: "Message Text",
  },
})

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.

Broadcast Message inputs
Property Type Description
scheduledAt Scheduled At string
Date/Time to send message in ISO 8601 timestamp format. Example: 2023-01-01T00:00:00.000Z. Not providing a runAt will schedule the message for immediate delivery.
Optional
text Message Text string
The text of the message to send.
Required
contacts Contacts string[]
Array of contact ids to send message to.
Required 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
project_broadcast-broadcast-message
Version
0.0.3
App
Project Broadcast
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes