View as Markdown
bot9 icon

bot9 ACTION

Initiate Chat

Initiates a new conversation with a Bot9 chatbot. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's bot9 account once, then configure and run Initiate Chat 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: "bot9-init-chat",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bot9: { authProvisionId: "apn_xxxxxxx" },
    chatbotId: "Chatbot ID",
    source: "Source",
  },
})

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.

Initiate Chat inputs
Property Type Description
chatbotId Chatbot ID string
The unique identifier for your Bot9 chatbot.
Required Dynamic
source Source string
The source from where the chat is initiated (e.g., WhatsApp, Facebook, etc.).
Required
status Status string
The status of the chat. The only valid value currently is active.
Required
externalSessionId External Session ID string
An ID you want to reference from an external system, such as your own database.
Optional
userName User Name string
The name of the user. If it does not exist, a randomly generated user is used.
Optional
userExternalId User External ID string
An ID you want to reference from an external system, such as your own database user ID.
Optional
userEmailId User Email string
The email ID of the user.
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
bot9-init-chat
Version
0.0.2
App
bot9
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes