Create Conversation with ChatBotKit API on New Table from PostgreSQL API

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

Trigger workflow on

New Table from the PostgreSQL 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 PostgreSQL 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 Table trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
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 Table on PostgreSQL

Description:Emit new event when a new table is added to the database. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.8

Key:postgresql-new-table

View on GitHub

PostgreSQL Overview#

On Pipedream, you can leverage the PostgreSQL app to create workflows that automate database operations, synchronize data across platforms, and react to database events in real-time. Think handling new row entries, updating records from webhooks, or even compiling reports on a set schedule. Pipedream's serverless platform provides a powerful way to connect PostgreSQL with a variety of apps, enabling you to create tailored automation that fits your specific needs.

Trigger Code#

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

export default {
  ...common,
  name: "New Table",
  key: "postgresql-new-table",
  description: "Emit new event when a new table is added to the database. [See the documentation](https://node-postgres.com/features/queries)",
  version: "2.0.8",
  type: "source",
  props: {
    ...common.props,
    schema: {
      propDefinition: [
        common.props.postgresql,
        "schema",
      ],
    },
  },
  async run() {
    const previousTables = this._getPreviousValues() || [];

    const tables = await this.postgresql.getTables(this.schema);

    const newTables = tables.filter((table) => !previousTables.includes(table));
    for (const table of newTables) {
      const meta = this.generateMeta(table);
      this.$emit(table, meta);
    }

    this._setPreviousValues(tables);
  },
};

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
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL 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
Schema	`schema`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs

SSL Setup

Configure SSL on your PostgreSQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications

About PostgreSQL#

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

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.2

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.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  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