Get Component with Pipedream API on New Bot Event Created from Botpress API

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

Trigger workflow on

New Bot Event Created from the Botpress API

Next, do this

Get Component with the Pipedream 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 Botpress trigger and Pipedream action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Bot Event Created trigger
1. Connect your Botpress account
2. Configure Polling Schedule
3. Select a Event Type
Configure the Get Component action
1. Connect your Pipedream account
2. Configure Component Key
3. Optional- Configure Pipedream Registry
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 Bot Event Created on Botpress

Description:Emit new event from bot is created. [See the documentation](https://botpress.com/docs/api-documentation/#list-events)

Version:0.0.1

Key:botpress-new-bot-event-created

View on GitHub

Botpress Overview#

Botpress is a powerful, open-source chatbot platform that enables developers to create intelligent, conversational bots. With its natural language understanding (NLU) capabilities, users can design bots that can interpret human language and respond appropriately. Utilizing the Botpress API on Pipedream allows you to automate interactions, analyze chat data, and integrate with various other services to enhance the functionality of your bots.

Trigger Code#

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

export default {
  ...common,
  key: "botpress-new-bot-event-created",
  name: "New Bot Event Created",
  description: "Emit new event from bot is created. [See the documentation](https://botpress.com/docs/api-documentation/#list-events)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    type: {
      type: "string",
      label: "Event Type",
      description: "The type of event to poll for",
      options: [
        "state_expired",
        "message_created",
        "task_update",
        "schedulev1",
        "botpublished",
        "botready",
        "resumeprocessing",
        "hitlAgent",
        "webchat:conversationStarted",
        "webchat:trigger",
      ],
    },
  },
  methods: {
    ...common.methods,
    getResourceName() {
      return "events";
    },
    getResourcesFn() {
      return this.app.listEvents;
    },
    getResourcesFnArgs() {
      return {
        params: {
          type: this.type,
        },
      };
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Event: ${resource.type}`,
        ts: Date.parse(resource.createdAt),
      };
    },
  },
};

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
Botpress	`app`	`app`	This component uses the Botpress app.
Polling Schedule	`timer`	`$.interface.timer`	How often to poll the API
Event Type	`type`	`string`	Select a value from the drop down menu:`state_expiredmessage_createdtask_updateschedulev1botpublishedbotreadyresumeprocessinghitlAgentwebchat:conversationStartedwebchat:trigger`

Trigger Authentication#

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

About Botpress#

Automate complex conversations, tasks, and workflows — reliably.

Action#

Get Component on Pipedream

Description:Get info for a published component. [See docs](https://pipedream.com/docs/api/rest/#get-a-component)

Version:0.1.0

Key:pipedream-get-component

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Action Code#

import pipedream from "../../pipedream.app.mjs";

export default {
  key: "pipedream-get-component",
  name: "Get Component",
  description: "Get info for a published component. [See docs](https://pipedream.com/docs/api/rest/#get-a-component)",
  version: "0.1.0",
  type: "action",
  props: {
    pipedream,
    componentKey: {
      propDefinition: [
        pipedream,
        "componentKey",
      ],
    },
    globalRegistry: {
      type: "boolean",
      label: "Pipedream Registry",
      description: "Defaults to `true`. If set to `true`, this will fetch component data from the public Pipedream registry. Set to `false` to search your private published components.",
      optional: true,
      default: true,
    },
  },
  async run({ $ }) {
    const { data } = await this.pipedream.getComponent(this.componentKey, this.globalRegistry);

    if (data) {
      $.export("$summary", `Succesfully fetched ${this.componentKey}`);
      return data;
    }

    console.log(`${this.componentKey} was not found`);
  },
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Component Key	`componentKey`	`string`	The component key (identified by the key property within the component's source code) you'd like to fetch metadata for (example: `github-new-commit-instant`)
Pipedream Registry	`globalRegistry`	`boolean`	Defaults to `true`. If set to `true`, this will fetch component data from the public Pipedream registry. Set to `false` to search your private published components.

Action Authentication#

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

About Pipedream#

Integration platform for developers

More Ways to Connect Pipedream + Botpress#

Other Popular Integrations#

List Conversations with Botpress API on New Scheduled Tasks from Pipedream API

Pipedream + Botpress

Get Component with Pipedream API on New Bot Event Created from Botpress API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular