Create an Image with Typeform API on New Message Sent from SnatchBot API

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

Trigger workflow on

New Message Sent from the SnatchBot API

Next, do this

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

Select this integration
Configure the New Message Sent trigger
1. Connect your SnatchBot account
2. Configure timer
3. Configure User ID
Configure the Create an Image action
1. Connect your Typeform account
2. Configure File name
3. Optional- Configure Base64 image
4. Optional- Configure Image's URL
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 Message Sent on SnatchBot

Description:Emit new event when a new bot message is sent. [See the documentation](https://support.snatchbot.me/reference/get-message)

Version:0.0.1

Key:snatchbot-new-message-sent

View on GitHub

SnatchBot Overview#

The SnatchBot API provides a programmatic window to SnatchBot's chatbot platform, allowing you to manage and interact with your bots outside of the SnatchBot interface. With this API, you can execute tasks like sending messages, retrieving chat history, and managing your bot's structure and behavior. When integrated into Pipedream workflows, the SnatchBot API shines in automating interactions, syncing chat data with other systems, and reacting to events with custom logic and third-party services.

Trigger Code#

import snatchbot from "../../snatchbot.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "snatchbot-new-message-sent",
  name: "New Message Sent",
  description: "Emit new event when a new bot message is sent. [See the documentation](https://support.snatchbot.me/reference/get-message)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    snatchbot,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    userId: {
      propDefinition: [
        snatchbot,
        "userId",
      ],
    },
  },
  hooks: {
    async deploy() {
      const messages = await this.getMessages();
      if (!messages.length) {
        return;
      }
      this.processMessages(messages.slice(0, 25));
    },
  },
  methods: {
    _getLastTs() {
      return this.db.get("lastTs") || 0;
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: message.message,
        ts: Date.parse(message.date),
      };
    },
    async getMessages() {
      const { messages } = await this.snatchbot.listMessages({
        params: {
          user_id: this.userId,
          message_id: 0,
        },
      });
      return messages;
    },
    processMessages(messages) {
      const lastTs = this._getLastTs();
      let maxLastTs = lastTs;

      for (const message of messages) {
        const ts = Date.parse(message.date);
        if (ts > lastTs) {
          const meta = this.generateMeta(message);
          this.$emit(message, meta);
          if (ts > maxLastTs) {
            maxLastTs = ts;
          }
        } else {
          break;
        }
      }

      this._setLastTs(maxLastTs);
    },
  },
  async run() {
    const messages = await this.getMessages();
    if (!messages.length) {
      return;
    }
    this.processMessages(messages);
  },
};

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
SnatchBot	`snatchbot`	`app`	This component uses the SnatchBot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
User ID	`userId`	`string`	The user ID in your application

Trigger Authentication#

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

To retrieve your App ID and Secret,

Navigate to your SnatchBot account and sign in
Click on one of your Bots, then click on “Channels”
Go to “Other” > “API”

In the steps above when you click one of your bots, your Bot ID is 1234 if your Bot URL is https://account.snatchbot.me/edit/1234

About SnatchBot#

A revolutionary bot builder platform to add multi-channel messaging to your system.

Action#

Create an Image on Typeform

Description:Adds an image in your Typeform account. [See the docs here](https://developer.typeform.com/create/reference/create-image/)

Version:0.0.2

Key:typeform-create-image

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.

Action Code#

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

export default {
  key: "typeform-create-image",
  name: "Create an Image",
  description: "Adds an image in your Typeform account. [See the docs here](https://developer.typeform.com/create/reference/create-image/)",
  type: "action",
  version: "0.0.2",
  props: {
    typeform,
    fileName: {
      type: "string",
      label: "File name",
      description: "File name for the image",
    },
    image: {
      type: "string",
      label: "Base64 image",
      description: "Base64 code for the image. Note that base64 encoders may add descriptors to the code (such as `data:image/png;base64,`). Do not include these descriptors in your image string---include only the base64 code. We also recommend that you don't paste the exact string value into this property box. Instead you can [pass an expression](https://pipedream.com/docs/workflows/steps/params/#entering-expressions) that references a variable from a previous step such as `{{steps.nodejs.$return_value}}`.",
      optional: true,
    },
    url: {
      type: "string",
      label: "Image's URL",
      description: "URL of the image to be added in your Typeform account",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.image && !this.url) {
      throw new Error("This action requires either Base64 image or Image's URL. Please enter one or the other above.");
    }

    const data = {
      file_name: this.fileName,
      image: this.image,
      url: this.url,
    };

    const resp = await this.typeform.createImage({
      $,
      data,
    });

    $.export("$summary", "Successfully added a new image to your account");

    return resp;
  },
};

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
Typeform	`typeform`	`app`	This component uses the Typeform app.
File name	`fileName`	`string`	File name for the image
Base64 image	`image`	`string`	Base64 code for the image. Note that base64 encoders may add descriptors to the code (such as `data:image/png;base64,`). Do not include these descriptors in your image string---include only the base64 code. We also recommend that you don't paste the exact string value into this property box. Instead you can pass an expression that references a variable from a previous step such as `{{steps.nodejs.$return_value}}`.
Image's URL	`url`	`string`	URL of the image to be added in your Typeform account

Action 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