View as Markdown
Vitally icon

Vitally ACTION

Create Message

Create a new message. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Vitally account once, then configure and run Create 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: "vitally-create-message",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    vitally: { authProvisionId: "apn_xxxxxxx" },
    organizationId: "Organization Id",
    conversationId: "Conversation 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 Message inputs
Property Type Description
organizationId Organization Id string
The Vitally assigned ID of the Organization.
Required Dynamic
conversationId Conversation Id string
The Conversation ID.
Required Dynamic
externalId External Id string
The unique ID of the message in your system.
Required
timestamp Timestamp string
The ISO-formatted string timestamp of when the message was sent.
Optional
message Message string
The HTML content of the message.
Required
from From string
The sender participant.
Required Dynamic
to To string[]
List of the recipient participants.
Required Dynamic
cc CC string[]
List of the cc recipient participants.
Optional Dynamic
bcc BCC string[]
List of the bcc recipient participants.
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
vitally-create-message
Version
0.0.3
App
Vitally
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes