Create Conversation with ChatBotKit API

Pipedream makes it easy to connect APIs for ChatBotKit and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Conversation with the ChatBotKit API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create Conversation with the ChatBotKit API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Conversation action
1. Connect your ChatBotKit account
2. Select a Message Type
3. Configure Message
4. Optional- Select a Bot ID
5. Optional- Configure Backstory
6. Optional- Select a Model
7. Optional- Select a Dataset ID
8. Optional- Select a Skillset ID
9. Optional- Configure Privacy
10. Optional- Configure Moderation
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Conversation with ChatBotKit API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ChatBotKit

Try it

Create Conversation with ChatBotKit API on New Submission from Typeform API

Typeform + ChatBotKit

Try it

Create Conversation with ChatBotKit API on Custom Events from Zoom API

Zoom + ChatBotKit

Try it

Create Conversation with ChatBotKit API on New Submission (Instant) from Jotform API

Jotform + ChatBotKit

Try it

Create Conversation with ChatBotKit API on New Scheduled Tasks from Pipedream API

Pipedream + ChatBotKit

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Conversation on ChatBotKit

Description:Creates a new conversation in the bot. [See the documentation](https://chatbotkit.com/docs/api/v1/spec)

Version:0.0.1

Key:chatbotkit-create-conversation

View on GitHub

Code#

import chatbotkit from "../../chatbotkit.app.mjs";
import constants from "../../common/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "chatbotkit-create-conversation",
  name: "Create Conversation",
  description: "Creates a new conversation in the bot. [See the documentation](https://chatbotkit.com/docs/api/v1/spec)",
  version: "0.0.1",
  type: "action",
  props: {
    chatbotkit,
    messageType: {
      type: "string",
      label: "Message Type",
      description: "The type of the message",
      options: constants.MESSAGE_TYPE,
    },
    message: {
      propDefinition: [
        chatbotkit,
        "message",
      ],
    },
    botId: {
      propDefinition: [
        chatbotkit,
        "botId",
      ],
      optional: true,
    },
    backstory: {
      type: "string",
      label: "Backstory",
      description: "The backstory for the conversation",
      optional: true,
    },
    model: {
      propDefinition: [
        chatbotkit,
        "model",
      ],
      optional: true,
    },
    datasetId: {
      propDefinition: [
        chatbotkit,
        "datasetId",
      ],
      optional: true,
    },
    skillsetId: {
      propDefinition: [
        chatbotkit,
        "skillsetId",
      ],
      optional: true,
    },
    privacy: {
      type: "boolean",
      label: "Privacy",
      description: "Turn conversation privacy features on",
      optional: true,
    },
    moderation: {
      type: "boolean",
      label: "Moderation",
      description: "Turn conversation moderation features on",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.botId && (this.datasetId || this.skillsetId)) {
      throw new ConfigurationError("Dataset ID & Skillset ID not for use with Bot ID.");
    }
    const conversation = await this.chatbotkit.createConversation({
      data: {
        botId: this.botId,
        backstory: this.backstory,
        model: this.model,
        datasetId: this.datasetId,
        skillsetId: this.skillsetId,
        privacy: this.privacy,
        moderation: this.moderation,
        messages: [
          {
            type: this.messageType,
            text: this.message,
          },
        ],
      },
      $,
    });
    $.export("$summary", `Created conversation with ID: ${conversation.id}`);
    return conversation;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
ChatBotKit	`chatbotkit`	`app`	This component uses the ChatBotKit app.
Message Type	`messageType`	`string`	Select a value from the drop down menu:`userbotcontextinstructionbackstory`
Message	`message`	`string`	The text of the message
Bot ID	`botId`	`string`	Select a value from the drop down menu.
Backstory	`backstory`	`string`	The backstory for the conversation
Model	`model`	`string`	Select a value from the drop down menu.
Dataset ID	`datasetId`	`string`	Select a value from the drop down menu.
Skillset ID	`skillsetId`	`string`	Select a value from the drop down menu.
Privacy	`privacy`	`boolean`	Turn conversation privacy features on
Moderation	`moderation`	`boolean`	Turn conversation moderation features on