Execute Runbook with Airplane API on New Guild Member from Discord Bot API

Pipedream makes it easy to connect APIs for Airplane, Discord Bot and 2,200+ other apps remarkably fast.

Trigger workflow on

New Guild Member from the Discord Bot API

Next, do this

Execute Runbook with the Airplane 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 Discord Bot trigger and Airplane action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Guild Member trigger
1. Connect your Discord Bot account
2. Select a Guild
3. Configure timer
Configure the Execute Runbook action
1. Connect your Airplane account
2. Optional- Configure Runbook ID
3. Optional- Configure Slug
4. Optional- Configure Parameter Values
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 Guild Member on Discord Bot

Description:Emit new event for every member added to a guild. [See docs here](https://discord.com/developers/docs/resources/guild#list-guild-members)

Version:0.1.4

Key:discord_bot-new-guild-member

View on GitHub

Discord Bot Overview#

The Discord Bot API unlocks the power to interact with Discord users and channels programmatically, making it possible to automate messages, manage servers, and integrate with other services. With Pipedream's serverless platform, you can create complex workflows that respond to events in Discord, process data, and trigger actions in other apps. This opens up opportunities for community engagement, content moderation, analytics, and more, without the overhead of managing infrastructure.

Trigger Code#

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

export default {
  ...common,
  key: "discord_bot-new-guild-member",
  name: "New Guild Member",
  description: "Emit new event for every member added to a guild. [See docs here](https://discord.com/developers/docs/resources/guild#list-guild-members)",
  type: "source",
  dedupe: "unique",
  version: "0.1.4",
  props: {
    ...common.props,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run({ $ }) {
    const { guildId } = this;
    const params = {
      limit: 100,
      after: this._getLastMemberID(),
    };

    while (true) {
      const members = await this.discord.getGuildMembers({
        $,
        guildId,
        params,
      });

      if (members.length === 0) {
        return;
      }

      for (const member of members) {
        const {
          user,
          joined_at: joinedAt,
        } = member;

        params.after = user.id;
        if (user.bot) continue;

        this.$emit(member, {
          summary: `New member: ${user.username}`,
          id: user.id,
          ts: Date.parse(joinedAt),
        });
      }

      this._setLastMemberID(params.after);
    }
  },
};

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
Discord Bot	`discord`	`app`	This component uses the Discord Bot app.
Guild	`guildId`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger 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.

About Discord Bot#

Use this app to interact with the Discord API using a bot in your account

Action#

Execute Runbook on Airplane

Description:Execute a runbook and receive a session ID to track the runbook's execution. [See the documentation](https://docs.airplane.dev/reference/api#runbooks-execute)

Version:0.0.1

Key:airplane-execute-runbook

View on GitHub

Airplane Overview#

The Airplane API facilitates the creation and management of tasks and runs within the Airplane toolkit, which is geared towards automating developer operations and internal tools. In Pipedream, you can leverage this API to automate workflows, integrate with various services, and handle background tasks. By connecting Airplane to other apps on Pipedream, you can streamline processes like deploying code, managing feature flags, or orchestrating complex workflows that interact with other APIs and services.

Action Code#

import airplane from "../../airplane.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "airplane-execute-runbook",
  name: "Execute Runbook",
  description: "Execute a runbook and receive a session ID to track the runbook's execution. [See the documentation](https://docs.airplane.dev/reference/api#runbooks-execute)",
  version: "0.0.1",
  type: "action",
  props: {
    airplane,
    id: {
      type: "string",
      label: "Runbook ID",
      description: "Unique ID of the runbook. You can find your runbook's ID by visiting the runbook's page on Airplane. The runbook ID is located at the end of the url. e.g. the runbook ID for `https://app.airplane.dev/runbooks/rbk20220120z15kl79` is `rbk20220120z15kl79`",
      optional: true,
    },
    slug: {
      type: "string",
      label: "Slug",
      description: "Unique slug of the runbook. You can find your runbook's slug next to the runbook's name within the runbook editor on Airplane. Either an ID or a slug must be provided.`",
      optional: true,
    },
    paramValues: {
      type: "object",
      label: "Parameter Values",
      description: "Mapping of parameter slug to value. You can find your runbooks's parameter slugs inside the runbook editor on Airplane.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.id && !this.slug) {
      throw new ConfigurationError("Either an ID or a slug must be provided.");
    }

    const response = await this.airplane.executeRunbook({
      data: {
        id: this.id,
        slug: this.slug,
        paramValues: this.paramValues,
      },
      $,
    });

    if (response) {
      $.export("$summary", "Successfully executed runbook.");
    }

    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
Airplane	`airplane`	`app`	This component uses the Airplane app.
Runbook ID	`id`	`string`	Unique ID of the runbook. You can find your runbook's ID by visiting the runbook's page on Airplane. The runbook ID is located at the end of the url. e.g. the runbook ID for `https://app.airplane.dev/runbooks/rbk20220120z15kl79` is `rbk20220120z15kl79`
Slug	`slug`	`string`	Unique slug of the runbook. You can find your runbook's slug next to the runbook's name within the runbook editor on Airplane. Either an ID or a slug must be provided.`
Parameter Values	`paramValues`	`object`	Mapping of parameter slug to value. You can find your runbooks's parameter slugs inside the runbook editor on Airplane.

Action Authentication#

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

Generate and copy your API Key using Airplane CLI.

About Airplane#

Code to internal apps in minutes. Turn APIs, SQL queries, and scripts into apps for the entire team.

More Ways to Connect Airplane + Discord Bot#

Other Popular Integrations#

Execute Task with Airplane API on New Forum Thread Message from Discord Bot API

Discord Bot + Airplane

Try it

Execute Task with Airplane API on New Guild Member from Discord Bot API

Discord Bot + Airplane

Try it

Execute Task with Airplane API on New Message in Channel from Discord Bot API

Discord Bot + Airplane

Try it

Execute Task with Airplane API on New Thread Message from Discord Bot API

Discord Bot + Airplane

Try it

Execute Runbook with Airplane API on New Forum Thread Message from Discord Bot API

Discord Bot + Airplane

Try it

Popular Triggers#

New Message in Channel from the Discord Bot API

Emit new event for each message posted to one or more channels

Try it

New Forum Thread Message from the Discord Bot API

Emit new event for each forum thread message posted. Note that your bot must have the MESSAGE_CONTENT privilege intent to see the message content, see the docs here.

Try it

New Guild Member from the Discord Bot API

Emit new event for every member added to a guild. See docs here

Try it

New Thread Message from the Discord Bot API

Emit new event for each thread message posted.

Try it