View as Markdown
Botpress icon

Botpress ACTION

Add Participant To Conversation

Adds a participant to a conversation. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Botpress account once, then configure and run Add Participant To Conversation 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: "botpress-add-participant",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    botpress: { authProvisionId: "apn_xxxxxxx" },
    conversationId: "Conversation ID",
    userId: "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.

Add Participant To Conversation inputs
Property Type Description
conversationId Conversation ID string
ID of the conversation.
Required Dynamic
userId User ID string
ID of the user.
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
botpress-add-participant
Version
0.0.2
App
Botpress
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes