Create Channel Invite with Discord Bot API on New Contact from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Discord Bot, Twilio SendGrid and 1200+ other apps remarkably fast.

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

Create Channel Invite with the Discord Bot API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Twilio SendGrid trigger and Discord Bot action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
Configure the Create Channel Invite action
1. Connect your Discord Bot account
2. Select a Guild
3. Select a Channel
4. Optional- Configure Max age
5. Optional- Configure Max number of uses
6. Optional- Configure Temporary membership
7. Optional- Configure Unique
8. Optional- Select a Target type
9. Optional- Configure Target user Id
10. Optional- Configure Target application id
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 Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.6

Key:sendgrid-new-contact

View on GitHub

Twilio SendGrid Overview#

With the Twilio SendGrid API, you can build a number of features into your
application to manage your SendGrid account and send emails. For example, you
can use the API to:

Create and manage SendGrid accounts
Send emails through SendGrid
Manage email templates
Get statistics on email sends
And more!

Trigger Code#

import orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.6",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Enter your Sendgrid API key below

About Twilio SendGrid#

Delivering your transactional and marketing emails through the world's largest cloud-based email delivery platform. Send with confidence.

Action#

Create Channel Invite on Discord Bot

Description:Create a new invite for the channel. [See the docs here](https://discord.com/developers/docs/resources/channel#create-channel-invite)

Version:0.0.7

Key:discord_bot-create-channel-invite

View on GitHub

Discord Bot Overview#

The Pipedream Discord app enables you to build event-driven workflows that interact with the Discord API. When you authorize the Pipedream app's access to your guilds, you can use Pipedream workflows to perform common Discord actions, or write your own code against the Discord API.

Action Code#

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

export default {
  ...common,
  key: "discord_bot-create-channel-invite",
  name: "Create Channel Invite",
  description: "Create a new invite for the channel. [See the docs here](https://discord.com/developers/docs/resources/channel#create-channel-invite)",
  type: "action",
  version: "0.0.7",
  props: {
    ...common.props,
    maxAge: {
      type: "integer",
      label: "Max age",
      description: "Duration of invite in seconds before expiry 0 for never. between 0 and 604800 (7 days).",
      optional: true,
    },
    maxUses: {
      type: "integer",
      label: "Max number of uses",
      description: "0 for unlimited. between 0 and 100.",
      optional: true,
    },
    temporary: {
      type: "boolean",
      label: "Temporary membership",
      description: "Whether this invite only grants temporary membership",
      optional: true,
    },
    unique: {
      type: "boolean",
      label: "Unique",
      description: "If true, don't try to reuse a similar invite (useful for creating many unique one time use invites)",
      optional: true,
    },
    targetType: {
      type: "integer",
      label: "Target type",
      description: "The type of target for this voice channel invite. [See the docs here](https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types)",
      optional: true,
      options: [
        {
          label: "Stream",
          value: constants.INVITE_TARGET_TYPES.STREAM,
        },
        {
          label: "Embedded Application",
          value: constants.INVITE_TARGET_TYPES.EMBEDDED_APPLICATION,
        },
      ],
    },
    targetUserId: {
      type: "string",
      label: "Target user Id",
      description: "The id of the user whose stream to display for this invite, required if Target type is Stream, the user must be streaming in the channel.",
      optional: true,
    },
    targetApplicationId: {
      type: "string",
      label: "Target application id",
      description: "The id of the embedded application to open for this invite, required if Target type is Embedded Application, the application must have the EMBEDDED flag.",
      optional: true,
    },
  },
  async run ({ $ }) {
    const {
      channelId,
      maxAge,
      maxUses,
      temporary,
      unique,
      targetType,
      targetUserId,
      targetApplicationId,
    } = this;

    const data = {
      max_age: maxAge,
      max_uses: maxUses,
      temporary,
      unique,
      target_type: targetType,
      target_user_id: targetUserId,
      target_application_id: targetApplicationId,
    };

    return this.discord.createChannelInvite({
      $,
      channelId,
      data,
    });
  },
};

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
Discord Bot	`discord`	`app`	This component uses the Discord Bot app.
Guild	`guildId`	`string`	Select a value from the drop down menu.
Channel	`channelId`	`string`	Select a value from the drop down menu.
Max age	`maxAge`	`integer`	Duration of invite in seconds before expiry 0 for never. between 0 and 604800 (7 days).
Max number of uses	`maxUses`	`integer`	0 for unlimited. between 0 and 100.
Temporary membership	`temporary`	`boolean`	Whether this invite only grants temporary membership
Unique	`unique`	`boolean`	If true, don't try to reuse a similar invite (useful for creating many unique one time use invites)
Target type	`targetType`	`integer`	Select a value from the drop down menu:`{ "label": "Stream", "value": 1 }{ "label": "Embedded Application", "value": 2 }`
Target user Id	`targetUserId`	`string`	The id of the user whose stream to display for this invite, required if Target type is Stream, the user must be streaming in the channel.
Target application id	`targetApplicationId`	`string`	The id of the embedded application to open for this invite, required if Target type is Embedded Application, the application must have the EMBEDDED flag.

Action Authentication#

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

This app allows you to use the Discord API using your own Discord bot. If you don't want to use a custom bot, and you just need to use the Discord API, exit this screen and use the Discord app, instead.

If you want to use your own Discord bot, but haven't created one yet, see these instructions or watch this video. You'll need to add this bot to your server(s) to make successful API requests.

Once you've created your bot, you'll find the Bot token within the Bot section of your app. Enter that token below.