Create Contact List with Twilio SendGrid API on New Event from ChatBot API

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

Trigger workflow on

New Event from the ChatBot API

Next, do this

Create Contact List with the Twilio SendGrid 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 ChatBot trigger and Twilio SendGrid action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event trigger
1. Connect your ChatBot account
2. Optional- Configure Webhook Name
Configure the Create Contact List action
1. Connect your Twilio SendGrid account
2. Configure Name
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 Event on ChatBot

Description:Emit new event for event received. *Need to be configured in the ChatBot UI flow to emit events*. [See docs here](https://www.chatbot.com/docs/webhooks/)

Version:0.0.1

Key:chatbot-new-event

View on GitHub

ChatBot Overview#

Leverage the ChatBot API on Pipedream to automate conversations, streamline customer service, and connect chat functionality with various apps for rich, responsive interaction. With this API, you can programmatically send messages, manage chat histories, and implement chatbots that react to user input in real-time. By integrating with Pipedream, these capabilities can be augmented with thousands of apps, enabling seamless data flow and complex automations.

Trigger Code#

import chatbot from "../../chatbot.app.mjs";
import { v4 as uuid } from "uuid";

export default {
  key: "chatbot-new-event",
  name: "New Event",
  description: "Emit new event for event received. *Need to be configured in the ChatBot UI flow to emit events*. [See docs here](https://www.chatbot.com/docs/webhooks/)",
  version: "0.0.1",
  type: "source",
  props: {
    chatbot,
    db: "$.service.db",
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    name: {
      label: "Webhook Name",
      description: "The name of the webhook, this will be used to select in the ChatBot UI flow",
      type: "string",
      optional: true,
    },
  },
  methods: {
    async _respondWebHook(http, event) {
      http.respond({
        status: 200,
        body: event.query.challenge,
      });
    },
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
  },
  hooks: {
    async activate() {
      const validationToken = uuid();

      const response = await this.chatbot.createWebhook({
        auth: {},
        headers: [],
        name: this.name ?? `Webhook ${validationToken}`,
        token: validationToken,
        url: this.http.endpoint,
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.chatbot.deleteWebhook(webhookId);
    },
  },
  async run(event) {
    await this._respondWebHook(this.http, event);

    const {
      body,
      headers,
    } = event;

    this.$emit(body, {
      id: headers["x-request-id"],
      summary: `New event ${headers["x-request-id"]} received`,
      ts: new Date(),
    });
  },
};

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
ChatBot	`chatbot`	`app`	This component uses the ChatBot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Webhook Name	`name`	`string`	The name of the webhook, this will be used to select in the ChatBot UI flow

Trigger Authentication#

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

To retrieve your API keys,

Navigate to your ChatBot account and sign in
Go to “Settings” > “Developers” > “API keys”

Note: The client access token should be used to invoke /query endpoint. For other API endpoints use the Developer access token

About ChatBot#

ChatBot is an all-in-one platform to create, deploy, and track chatbots across channels.

Action#

Create Contact List on Twilio SendGrid

Description:Allows you to create a new contact list. [See the docs here](https://docs.sendgrid.com/api-reference/lists/create-list)

Version:0.0.4

Key:sendgrid-create-contact-list

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Action Code#

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

export default {
  ...common,
  key: "sendgrid-create-contact-list",
  name: "Create Contact List",
  description: "Allows you to create a new contact list. [See the docs here](https://docs.sendgrid.com/api-reference/lists/create-list)",
  version: "0.0.4",
  type: "action",
  props: {
    ...common.props,
    name: {
      type: "string",
      label: "Name",
      description: "Your name for your list. maxLength: 100",
    },
  },
  async run({ $ }) {
    const resp = await this.sendgrid.createContactList(this.name);
    $.export("$summary", `Successfully created contact ${this.name}`);
    return resp;
  },
};