Create Channel Invite with Discord Bot API

Pipedream makes it easy to connect APIs for Discord Bot and 2,400+ 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

▶

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#

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.

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

Integrations#

Create Channel Invite with Discord Bot API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Discord Bot

Try it

Create Channel Invite with Discord Bot API on New Item in Feed from RSS API

RSS + Discord Bot

Try it

Create Channel Invite with Discord Bot API on New Message from Discord API

Discord + Discord Bot

Try it

Create Channel Invite with Discord Bot API on New Message In Channels from Slack API

Slack + Discord Bot

Try it

Create Channel Invite with Discord Bot API on New Message in Channel from Discord Bot API

Discord Bot + Discord Bot

Try it

Details#

This is a pre-built, source-available 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.12

Key:discord_bot-create-channel-invite

View on GitHub

Code#

import constants from "../../common/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.12",
  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.

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.

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

More Ways to Use Discord Bot#

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

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 Tag Added to Forum Thread from the Discord Bot API

Emit new event when a new tag is added to a thread

Try it

New Thread Message from the Discord Bot API

Emit new event for each thread message posted.

Try it