View as Markdown
ChatBotKit icon

ChatBotKit ACTION

Create Conversation

Creates a new conversation in the bot. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ChatBotKit account once, then configure and run Create 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: "chatbotkit-create-conversation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    chatbotkit: { authProvisionId: "apn_xxxxxxx" },
    messageType: "Message Type",
    message: "Message",
  },
})

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 Conversation inputs
Property Type Description
messageType Message Type string
The type of the message
Required
message Message string
The text of the message
Required
botId Bot ID string
The bot id assigned to this conversation
Optional Dynamic
backstory Backstory string
The backstory for the conversation
Optional
model Model string
The model to use for the conversation
Optional Dynamic
datasetId Dataset ID string
The ID of the dataset to use for the conversation. Not for use with Bot ID.
Optional Dynamic
skillsetId Skillset ID string
The ID of the skillset to use for the conversation. Not for use with Bot ID.
Optional Dynamic
privacy Privacy boolean
Turn conversation privacy features on
Optional
moderation Moderation boolean
Turn conversation moderation features on
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
chatbotkit-create-conversation
Version
0.0.2
App
ChatBotKit
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes