Create Conversation with ChatBotKit API on New Collection from MongoDB API

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

Trigger workflow on

New Collection from the MongoDB API

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#

This integration creates a workflow with a MongoDB trigger and ChatBotKit action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Collection trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Collection on MongoDB

Description:Emit new an event when a new collection is added to a database

Version:0.0.7

Key:mongodb-new-collection

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "mongodb-new-collection",
  name: "New Collection",
  description: "Emit new an event when a new collection is added to a database",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
  },
  methods: {
    ...common.methods,
    _getCollectionIds() {
      return this.db.get("collectionIds");
    },
    _setCollectionIds(collectionIds) {
      this.db.set("collectionIds", collectionIds);
    },
    isRelevant(uuid, collectionIds) {
      return !collectionIds.includes(uuid);
    },
    async processEvent(client, ts) {
      const collectionIds = this._getCollectionIds() || [];
      const collections = await this.mongodb.listCollections(client, this.database);
      for (const collection of collections) {
        const uuid = JSON.stringify(collection.info.uuid);
        if (!this.isRelevant(uuid, collectionIds)) {
          continue;
        }
        collectionIds.push(uuid);
        this.emitEvent(collection, ts);
      }
      this._setCollectionIds(collectionIds);
    },
    generateMeta({
      info, name,
    }, ts) {
      return {
        id: info.uuid,
        summary: name,
        ts,
      };
    },
  },
};

Trigger 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
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.

Trigger Authentication#

MongoDB uses API keys for authentication. When you connect your MongoDB account, Pipedream securely stores the keys so you can easily authenticate to MongoDB APIs in both code and no-code steps.

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

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

ChatBotKit Overview#

ChatBotKit API empowers you to create and manage conversational experiences with ease. Within Pipedream, you can leverage this API to automate interactions, analyze message content, and enhance customer engagement by integrating with other apps. Think of ChatBotKit as the backbone of your chatbot logic, while Pipedream serves as the orchestrator, connecting your bot to a vast array of services, databases, and communication platforms.

Action 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;
  },
};

Action Configuration#

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

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