Initiate Chat with bot9 API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for bot9, Typeform and 2,800+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

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

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Initiate Chat action
1. Connect your bot9 account
2. Select a Chatbot ID
3. Select a Source
4. Select a Status
5. Optional- Configure External Session ID
6. Optional- Configure User Name
7. Optional- Configure User External ID
8. Optional- Configure User Email
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  sampleEmit,
};

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
Typeform	`typeform`	`app`	This component uses the Typeform app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Typeform uses OAuth authentication. When you connect your Typeform account, Pipedream will open a popup window where you can sign into Typeform and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Typeform API.

Pipedream requests the following authorization scopes when you connect your account:

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Initiate Chat on bot9

Description:Initiates a new conversation with a Bot9 chatbot. [See the documentation](https://bot9ai.apimatic.dev/v/1_0#/rest/introduction/introduction/getting-started-with-bot9/end-user-chat-api/initchat-endpoint)

Version:0.0.2

Key:bot9-init-chat

View on GitHub

bot9 Overview#

The Bot9 API enables automated interactions with trading systems, allowing users to execute, manage, and analyze trades through a programmatic interface. In Pipedream, you can leverage this API to craft serverless workflows that handle trading tasks, notifications, and analyses without needing to build a full backend system. This can speed up trade execution, improve response times to market changes, and enable complex trading strategies that adjust to live market data.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import app from "../../bot9.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "bot9-init-chat",
  name: "Initiate Chat",
  description: "Initiates a new conversation with a Bot9 chatbot. [See the documentation](https://bot9ai.apimatic.dev/v/1_0#/rest/introduction/introduction/getting-started-with-bot9/end-user-chat-api/initchat-endpoint)",
  version: "0.0.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    chatbotId: {
      propDefinition: [
        app,
        "chatbotId",
      ],
    },
    source: {
      propDefinition: [
        app,
        "source",
      ],
    },
    status: {
      propDefinition: [
        app,
        "status",
      ],
    },
    externalSessionId: {
      propDefinition: [
        app,
        "externalSessionId",
      ],
    },
    userName: {
      propDefinition: [
        app,
        "userName",
      ],
    },
    userExternalId: {
      propDefinition: [
        app,
        "userExternalId",
      ],
    },
    userEmailId: {
      propDefinition: [
        app,
        "userEmailId",
      ],
    },
  },
  methods: {
    initChat({
      chatbotId, ...args
    } = {}) {
      return this.app.post({
        path: `/${chatbotId}/conversations`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      initChat,
      chatbotId,
      source,
      status,
      externalSessionId,
      userName,
      userExternalId,
      userEmailId,
    } = this;

    if (!source || !status) {
      throw new ConfigurationError("Source and Status are required.");
    }

    const response = await initChat({
      $,
      chatbotId,
      data: utils.reduceProperties({
        initialProps: {
          Source: source,
          Status: status,
        },
        additionalProps: {
          ExternalSessionId: externalSessionId,
          user: [
            {
              name: userName,
              externalId: userExternalId,
              emailId: userEmailId,
            },
            userName || userExternalId || userEmailId,
          ],
        },
      }),
    });

    $.export("$summary", `Successfully initiated conversation with ID: \`${response.id}\``);
    return response;
  },
};

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
bot9	`app`	`app`	This component uses the bot9 app.
Chatbot ID	`chatbotId`	`string`	Select a value from the drop down menu.
Source	`source`	`string`	Select a value from the drop down menu:`{ "label": "WhatsApp", "value": "whatsapp" }{ "label": "Intercom", "value": "intercom" }{ "label": "Slack", "value": "slack" }{ "label": "Crisp", "value": "crisp" }{ "label": "Zapier", "value": "zapier" }{ "label": "Zendesk", "value": "zendesk" }{ "label": "Zoko", "value": "zoko" }{ "label": "Freshdesk", "value": "freshdesk" }{ "label": "Website Widget", "value": "website-widget" }{ "label": "Debugger", "value": "debugger" }{ "label": "Discord", "value": "discord" }{ "label": "Stripe", "value": "stripe" }{ "label": "Meta Messenger", "value": "meta-messenger" }{ "label": "Other", "value": "other" }`
Status	`status`	`string`	Select a value from the drop down menu:`{ "label": "Active", "value": "active" }`
External Session ID	`externalSessionId`	`string`	An ID you want to reference from an external system, such as your own database.
User Name	`userName`	`string`	The name of the user. If it does not exist, a randomly generated user is used.
User External ID	`userExternalId`	`string`	An ID you want to reference from an external system, such as your own database user ID.
User Email	`userEmailId`	`string`	The email ID of the user.