Update Survey with SurveySparrow API on New Bot Event Created from Botpress API

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

Trigger workflow on

New Bot Event Created from the Botpress API

Next, do this

Update Survey with the SurveySparrow 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 SurveySparrow 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 Update Survey action
1. Connect your SurveySparrow account
2. Select a Survey
3. Optional- Configure Name
4. Optional- Configure Welcome Text
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#

Update Survey on SurveySparrow

Description:Updates an existing survey. [See the documentation](https://developers.surveysparrow.com/rest-apis/survey#patchV3SurveysId)

Version:0.0.2

Key:surveysparrow-update-survey

View on GitHub

SurveySparrow Overview#

The SurveySparrow API lets you tap into a robust platform for gathering feedback and insights. With Pipedream, you can automate interactions with your surveys, manage contacts, and analyze responses in real time. You can create workflows that trigger on new survey responses, sync data to other services, or even kick off email campaigns based on survey results. The power of Pipedream's serverless platform means you can integrate SurveySparrow with hundreds of other apps, enabling limitless automation scenarios without writing extensive code.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import pickBy from "lodash.pickby";
import surveySparrow from "../../surveysparrow.app.mjs";

export default {
  key: "surveysparrow-update-survey",
  name: "Update Survey",
  description: "Updates an existing survey. [See the documentation](https://developers.surveysparrow.com/rest-apis/survey#patchV3SurveysId)",
  version: "0.0.2",
  type: "action",
  props: {
    surveySparrow,
    survey: {
      propDefinition: [
        surveySparrow,
        "survey",
      ],
    },
    name: {
      propDefinition: [
        surveySparrow,
        "name",
      ],
      optional: true,
    },
    welcomeText: {
      propDefinition: [
        surveySparrow,
        "welcomeText",
      ],
    },
  },
  async run({ $ }) {
    if (!this.name && !this.welcomeText) {
      throw new ConfigurationError("At least one of `name` or `welcomeText` must be provided.");
    }

    const { data: response } = await this.surveySparrow.updateSurvey({
      surveyId: this.survey,
      data: pickBy({
        name: this.name,
        welcome_text: this.welcomeText,
      }),
      $,
    });

    if (response) {
      $.export("$summary", `Successfully updated survey with ID ${response[0].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
SurveySparrow	`surveySparrow`	`app`	This component uses the SurveySparrow app.
Survey	`survey`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the survey
Welcome Text	`welcomeText`	`string`	Welcome Text of the survey

Action Authentication#

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

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

Update Survey with SurveySparrow API on New Bot Event Created from Botpress API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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