Discord¶
The Discord modules allow you to create, update, list, and/or delete channels, channel messages, reactions, webhooks in your Discord account.
To get started with Discord, create an account at https://discordapp.com/register?.
Note
According to Discord, message content will be categorized as Privileged Intent starting on September 1, 2022.
This means that users who have installed our verified bot on their Discord server will not be able to use the following Ibexa Connect modules with the bot:
- Watch Channel Messages
- List Channel Messages
- Get a Message
Users who installed the verified bot to connect to the Discord app on our platform will see the empty values of messages that the channel member sends for the fields, content, embeds, attachments, and components in the output.
The verified bot is still able to receive the messages for the above modules under the following conditions:
- Messages the bot sends
- Messages the bot receives in DMs
- Messages in which the bot is mentioned
If you want to use the aforementioned modules, you can create a custom connection using a separate client ID.
Connecting Discord to Ibexa Connect¶
To connect your Discord account to Ibexa Connect, you need to create a server and channels.
-
Login to your Discord account and create a server.
-
Enter the details of the server and click Create.
-
Go to Ibexa Connect and open the Discord module's Create a connection dialog.
-
Select the server created in step 1, allow the permissions for messages and channels, and click Authorize.
The connection has been established.
Messages¶
Post a Message¶
Posts a message.
Required Permissions: webhook.incoming
| Content | Enter the message text. |
| moduleWebhookUrl | Enter the webhook URL address to post the message. |
Post a Message with Embed Objects¶
Posts a message with embedded objects.
Required Permissions: webhook.incoming
| Content | Enter the message text. |
| Array of embedded objects | Enter the details of the embedded objects. |
Post a Message with a File¶
Posts a message with an attached file.
Required Permissions: webhook.incoming
| Content | Enter the message text. |
| Source File | Select the file to attach to the message you want to post: * Dropbox - Get a file * Map |
Get a Message¶
Returns a specific message in the channel.
| Channel ID | Select the Channel ID whose messages you want to retrieve. |
| Message ID | Select the Message ID whose details you want to retrieve. |
Delete a Message¶
Deletes a message.
| Channel ID | Enter the Channel ID whose message you want to delete. |
| Message ID | Enter the Message ID you want to delete. |
List Channel Messages¶
Returns the message for the channel.
| Channel ID | Select the Channel ID whose messages you want to list. |
| Limit | The maximum number of messages Ibexa Connect should return during one scenario execution cycle. |
Watch Channel Messages¶
Triggers when a new message is posted to the channel.
| Channel ID | Select the Channel ID whose message you want to watch. |
| Limit | The maximum number of channel messages Ibexa Connect should return during one scenario execution cycle. |
Channels¶
Create a Guild Channel¶
Creates a new channel for the guild.
| Name | Enter the name for the guild channel. |
| Type | Select the type of guild channel: * Guild text * DM * Guild voice * Guild DM * Guild Category * Guild News * Guild store |
| Topic | Enter the topic name for the guild channel. |
| Permission Overwrites | Add the permission overwrites for the channel: * Role ID Select the Role ID of the user. * Allow permission bit set Enter the number of permission bit set to allow. * Deny permission bit set Enter the number of permission bit set to deny. |
| Position | Enter the sorting position of the guild channel. |
| Rate Limit Per User | Enter the number of seconds the user has to wait before sending the next message in the guild channel. |
| Parent ID | Select the Parent ID of the guild channel: * Text Channel * Voice Channel |
| NSFW Channel | Select Yes if this guild channel is NSFW (Not Suitable For Wumpus). * Yes * No * Not defined For more information on NSFW, see NSFW Channels and Content. |
Create a Channel Invite¶
Creates a new invite for the channel. It works only with a connection that has permissions to manage invites.
| Channel ID | Select the Channel ID whose invite you want to create. |
| Max age | Enter the maximum duration after which the invite expires. Enter the duration of invite in seconds before expiry, or 0 for never. Note: 86400 is 24 hours |
| Max uses | Enter the maximum number of time the channel invite can be used. Enter Zero for unlimited. |
| Is temporary? | Select if this channel invite gives a temporary membership. |
| Is unique? | Select if this channel invites can be used only once. If selected, you cannot create a similar channel invite. |
Modify a Channel¶
Updates a channel's settings.
| Channel ID | Enter the Channel ID you want to modify. |
| Name | Enter a new name for the channel. |
| Type | Select the channel type. |
| Topic | Enter a topic for the channel. |
| Position | Enter the channel sorting position of the guild channel. |
| Rate Limit per User | Enter the time in seconds a user has to wait before sending another message (0-21600). |
| Parent ID | Select the Parent ID of the guild channel: * Text Channel * Voice Channel |
| NSFW Channel | Select Yes if this guild channel is NSFW (Not Suitable For Wumpus). * Yes * No * Not defined For more information on NSFW, see NSFW Channels and Content. |
| Permission Overwrites | Add the permissions for members to overwrite: Role ID Select the role or members to whom you want to assign the permission. Allow Permission Bit Set Enter the permission allowed in a bit set. Deny Permission Bit Set Enter the permission denied in a bit set. |
| Bitrate | Enter the bitrate (in bits) if this is a voice channel. |
| User Limit | Enter the maximum number of users you can add to the channel. |
Delete a Channel¶
Deletes a channel.
| Channel ID | Select the Channel ID you want to delete. |
List Channel Invites¶
Returns a list of invites (with invite metadata) for the channel.
| Channel ID | Select the Channel ID whose channel invite you want to list. |
| Limit | The maximum number of channel invites Ibexa Connect should return during one scenario execution cycle |
List Channels¶
Returns a list of bot's channels.
| Channel ID | Select the Channel ID whose bot's channels you want to list. |
| Limit | The maximum number of channels Ibexa Connect should return during one scenario execution cycle |
Watch Channel Invites¶
Triggers when a new channel invite is created.
| Channel ID | Select the Channel ID whose channel invites you want to watch. |
| Limit | The maximum number of channel invites Ibexa Connect should return during one scenario execution cycle |
Reactions¶
Post a Reaction with an Emoji¶
Post a reaction for the message with an emoji.
| Channel ID | Select the Channel ID where you want to post a reaction with an emoji. |
| Message ID | Enter the Message ID that you want to post a reaction with an emoji. |
| Emoji | Enter the emoji to post as a reaction to the message. |
Members¶
List Guild Members¶
Returns a list of members that are members of the bot's guild.
| Limit | The maximum number of Guild Members Ibexa Connect should return during one scenario execution cycle. |
List Users that Reacted with the Emoji¶
Returns a list of users that reacted with the emoji.
| Channel ID | Select the Channel ID of the users who reacted with an emoji that you want to list. |
| Limit | The maximum number of users Ibexa Connect should return during one scenario execution cycle. |
| Message ID | Select the Message ID that has the reaction with an emoji that you want to list the users of. |
| Emoji | Enter the emoji you want to list. |
Watch Guild Members¶
Triggers when a member has joined the bot's guild.
| Limit | The maximum number of guild members Ibexa Connect should return during one scenario execution cycle |
Add a Role to a Guild Member¶
Adds a Role to a Guild Member.
| User ID | Select the User ID whose role you want to add to a guild member. |
| Role ID | Select the Role ID of the user you want to add. |
Remove a Role from a Guild Member¶
Removes a role from a guild member,
| User ID | Select the User ID whose role you want to remove from a guild member. |
| Role ID | Select the Role ID of the user you want to remove. |
Webhooks¶
Create a webhook¶
Creates a new webhook.
| Channel ID | Select the Channel ID whose webhook you want to create. |
| Name | Enter a name for the webhook. |
Execute a webhook¶
Executes a webhook.
| Channel ID | Select the Channel ID whose webhook you want to execute. |
| Name | Enter the webhook name you want to execute. |
Delete a Webhook¶
Deletes a webhook permanently
| ID | Enter the Webhook ID you want to delete. |
Make an API Call¶
Performs an arbitrary authorized API call to manage data in Discord.
URL
Enter a path relative to https://discordapp.com/api.
Note
For the list of available endpoints, refer to the Discord API Documentation.
Method
Select the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body Type
Select the method in which you want to map the body content.
Body
Enter the body content for your API call.
Example of Use - Get User¶
The following API call returns all the information about the selected user:
URL:
/users/@me
Method:
GET
Matches of the search can be found in the module's Output under Bundle > Body.
In our example, the details of the user were returned:
