View as Markdown
Discord Bot icon

Discord Bot ACTION

Create Channel Invite

Create a new invite for the channel. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Discord Bot account once, then configure and run Create Channel Invite from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "discord_bot-create-channel-invite",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    discord_bot: { authProvisionId: "apn_xxxxxxx" },
    guildId: "Guild",
    channelId: "Channel",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Channel Invite inputs
Property Type Description
guildId Guild string
Discord Guild where your channel lives
Required Dynamic
channelId Channel string
Please select a channel
Required Dynamic
maxAge Max age integer
Duration of invite in seconds before expiry 0 for never. between 0 and 604800 (7 days).
Optional
maxUses Max number of uses integer
0 for unlimited. between 0 and 100.
Optional
temporary Temporary membership boolean
Whether this invite only grants temporary membership
Optional
unique Unique boolean
If true, don't try to reuse a similar invite (useful for creating many unique one time use invites)
Optional
targetType Target type integer
The type of target for this voice channel invite. See the docs here
Optional
targetUserId Target user Id 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.
Optional
targetApplicationId Target application id 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.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
discord_bot-create-channel-invite
Version
1.0.2
App
Discord Bot
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes