← Discord Bot

Create Channel Invite with Discord Bot API

Pipedream makes it easy to connect APIs for Discord Bot and 700+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Channel Invite with the Discord Bot API
No credit card required
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Create Channel Invite with the Discord Bot API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

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.1
Key:discord_bot-create-channel-invite

Code

import common from "../common.mjs";
import constants from "../../constants.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.1",
  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,
    });
  },
};

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.
LabelPropTypeDescription
Discord BotdiscordappThis component uses the Discord Bot app.
GuildguildIdstringSelect a value from the drop down menu.
ChannelchannelIdstringSelect a value from the drop down menu.
Max agemaxAgeinteger

Duration of invite in seconds before expiry 0 for never. between 0 and 604800 (7 days).

Max number of usesmaxUsesinteger

0 for unlimited. between 0 and 100.

Temporary membershiptemporaryboolean

Whether this invite only grants temporary membership

Uniqueuniqueboolean

If true, don't try to reuse a similar invite (useful for creating many unique one time use invites)

Target typetargetTypeintegerSelect a value from the drop down menu:{ "label": "Stream", "value": 1 }{ "label": "Embedded Application", "value": 2 }
Target user IdtargetUserIdstring

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 idtargetApplicationIdstring

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.

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.

If you haven't created a Discord bot, see these instructions or watch this video. You'll need to add this bot to your server(s).

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

About Discord Bot

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

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday