View as Markdown
Chatforma icon

Chatforma ACTION

Create User Broadcast

Sends a broadcast message to a specific user. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Chatforma account once, then configure and run Create User Broadcast 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: "chatforma-create-user-broadcast",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    chatforma: { authProvisionId: "apn_xxxxxxx" },
    botId: "Bot ID",
    botUserId: "Bot User ID",
  },
})

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.

Create User Broadcast inputs
Property Type Description
botId Bot ID string
The unique identifier of the bot
Required Dynamic
botUserId Bot User ID string
The unique identifier of the bot user
Required Dynamic
content Content string
The content of the message to broadcast
Required
runAt Run 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

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
chatforma-create-user-broadcast
Version
0.0.1
App
Chatforma
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes