Skip to content
Nappai Documentation

Channel

Use this component to manage channels in your Discord servers. You can retrieve channel information, update channel details like names or topics, and process multiple channels at once. This component acts as a bridge between Nappai and Discord, allowing you to automate routine tasks and keep your server organization up to date.

How it Works

The component connects to your Discord account using a secure API connection. It can read channel data, create or update channels, and perform actions on specific channels within a server. When you configure the component with a Server ID and Channel ID, it knows exactly which channel to work on. It handles all the technical communication with Discord behind the scenes, so you can focus on defining what changes you want to make or what information you need.

Connection & Credentials

This component requires configuring a credential in the Nappai panel before interacting with the external service:

  1. Go to the Credentials section in your Nappai panel.
  2. Create a new credential of the type Discord API and fill in the required fields (Public Key, Application ID, Bot Token). You can find these details in the Discord Developer Portal under your application’s Bot section.
  3. In your workflow, select the saved credential in the Credential input field of this node.

Inputs

Mapping Mode

This component has a special mode called “Mapping Mode”. When you enable this mode using the toggle switch, an additional input called “Mapping Data” is activated, and each input field offers you three different ways to provide data:

  • Fixed: You type the value directly into the field.
  • Mapped: You connect the output of another component to use its result as the value.
  • Javascript: You write Javascript code to dynamically calculate the value.

This flexibility allows you to create more dynamic and connected workflows.

Input Fields

  • Operation: Select the operation mode to define how the component behaves.
  • Guild ID: The unique identifier of your Discord server.
  • Item: A data structure that defines the details of a channel to be created. It must include the channel name and type, and can optionally include options like the topic or NSFW status.
  • Channel ID: The unique identifier of the specific channel you want to manage.
  • Top: The maximum number of channels to retrieve from the server.
  • Filter Type: A number that represents the type of channel, such as 0 for text channels or 2 for voice channels.
  • Name: The name you want to assign to a channel or the name of the channel being created.
  • Options: A data object containing settings to apply to a channel, such as the topic, whether it is NSFW, bitrate for voice channels, or parent category ID.
  • Mode: Choose whether to provide a complete Data object or enter channel details manually.
  • Filter: Choose whether to retrieve channels from a Guild (server) or look up a specific Channel ID.
  • Type: Define the type of the channel being created, such as text or voice.

Outputs

The component returns a data object containing information about the channel(s) managed. This output includes details like the channel ID, name, type, position, topic, and permissions. You can use this output to verify changes or pass channel information to other components in your workflow.

Output Data Examplejson

{ “id”: “123456789012345678”, “name”: “general”, “type”: 0, “position”: 1, “topic”: “Welcome to our community!”, “nsfw”: false, “permissions”: “8” }

Connectivity

This component is typically used in workflows that manage server organization or automate channel updates. You can connect inputs like Guild ID and Channel ID from previous components to dynamically target specific servers or channels. The output Data can be mapped to subsequent nodes that need channel details, such as components that send messages to the channel or components that log channel information.

Usage Example

Updating a Channel Name:

  1. Provide your Guild ID and the Channel ID of the channel you want to update.
  2. Enter the new name in the Name field.
  3. Run the workflow. The component will update the channel in Discord with the new name and return the updated channel data.

Creating a New Channel:

  1. Set the Item field with a data object containing name, type, and optional options.
  2. Run the workflow. The component will create the channel in the specified server and return the details of the newly created channel.

Tips and Best Practices

  • Ensure your Discord Bot has the necessary permissions (e.g., “Manage Channels”) to perform the actions you require.
  • Use Mapping Mode when you need to process or update multiple channels at once to improve workflow efficiency.
  • Double-check Channel ID and Guild ID values to avoid errors or targeting the wrong resources.
  • When using the Options field, only include settings relevant to your operation to keep the payload clean.

Security Considerations

  • Always store your Discord Bot Token securely within Nappai credentials. Never share tokens publicly.
  • Ensure your Bot Token has appropriate permissions and is limited to only what is necessary for your workflow.
  • Nappai handles credential storage securely; do not expose credentials in workflow logs or shared nodes.