Value types
Every input, output and provided value of a trigger or action has a type. The type decides which values you can connect to it and which values it accepts. Each type name in the reference tables links to its entry on this page.
| Name | Details |
|---|---|
| Basic types | Plain values such as text, numbers, yes/no values and times. |
| Lists and lookup tables | Lists and lookup tables hold several values. In the reference tables they are shown together with the type of their items, for example "List of Text". |
| Choice lists | Values that are picked from a fixed list of choices. |
| Objects | Things such as channels, members or messages. Each has fields you can read in your flow. |
| Special types | Types whose exact shape depends on how and where they are used. |
Basic types
Plain values such as text, numbers, yes/no values and times.
Text
Example: Hello there.
Whole number
Example: 42.
Decimal number
Example: 3.5.
Large whole number
Example: 9007199254740993.
Yes/No
Example: Yes.
Discord ID
Example: 123456789012345678.
ID
Example: A1B2-C3D4.
Date and time
Example: Oct 1, 2026, 6:30 PM.
Duration
Example: 5 minutes.
URL
Example: https://example.com.
Color
Example: #5865F2.
Lists and lookup tables
Lists and lookup tables hold several values. In the reference tables they are shown together with the type of their items, for example "List of Text".
List
An ordered list of values of the same type.
Lookup table
A lookup table: values of one type that you find by a key.
Choice lists
Values that are picked from a fixed list of choices.
Channel type
The kind of a Discord channel.
| Value | Name | Details |
|---|---|---|
GUILD_TEXT | Text channel | A regular text channel on your server. |
GUILD_ANNOUNCEMENT | Announcement channel | An announcement channel that members can follow. |
GUILD_VOICE | Voice channel | A voice channel on your server. |
GUILD_STAGE_VOICE | Stage channel | A stage channel for moderated audio events. |
GUILD_CATEGORY | Category | A category that groups other channels. |
GUILD_DIRECTORY | Directory | A directory channel, only found in Student Hub servers. |
GUILD_FORUM | Forum channel | A forum channel containing posts as threads. |
GUILD_MEDIA | Media channel | A media channel similar to a forum. |
ANNOUNCEMENT_THREAD | Announcement thread | A thread inside an announcement channel. |
PUBLIC_THREAD | Public thread | A public thread inside a text or forum channel. |
PRIVATE_THREAD | Private thread | A private, invite-only thread. |
DM | Direct message | A 1:1 direct message channel. |
GROUP_DM | Group DM | A group direct message channel. |
Permission
A Discord permission flag.
| Value | Name | Details |
|---|---|---|
VIEW_CHANNEL | View channel | Allows viewing a channel. |
MANAGE_CHANNELS | Manage channels | Allows creating, editing and deleting channels. |
MANAGE_ROLES | Manage roles | Allows creating, editing and deleting roles. |
MANAGE_GUILD | Manage server | Allows changing server settings. |
ADMINISTRATOR | Administrator | Grants every permission and bypasses channel overrides. |
VIEW_AUDIT_LOG | View audit log | Allows reading the audit log. |
VIEW_GUILD_INSIGHTS | View server insights | Allows viewing server insights. |
MANAGE_WEBHOOKS | Manage webhooks | Allows creating, editing and deleting webhooks. |
MANAGE_GUILD_EXPRESSIONS | Manage expressions | Allows managing emojis, stickers and soundboards. |
MANAGE_EVENTS | Manage events | Allows creating, editing and ending scheduled events. |
CREATE_INSTANT_INVITE | Create invite | Allows creating invites to the server. |
CREATE_EVENTS | Create events | Allows creating scheduled events and editing or deleting your own. |
CREATE_GUILD_EXPRESSIONS | Create expressions | Allows creating emojis, stickers and soundboard sounds, and editing or deleting your own. |
MANAGE_EMOJIS_AND_STICKERS | Manage emojis and stickers (old name) | The older name of Manage expressions. Discord reports both for the same permission. |
VIEW_CREATOR_MONETIZATION_ANALYTICS | View creator monetization analytics | Allows viewing the insights of the server's role subscriptions. |
KICK_MEMBERS | Kick members | Allows kicking members from the server. |
BAN_MEMBERS | Ban members | Allows banning members from the server. |
MODERATE_MEMBERS | Time out members | Allows timing members out. |
MANAGE_NICKNAMES | Manage nicknames | Allows changing other members' nicknames. |
CHANGE_NICKNAME | Change own nickname | Allows changing the bot's own nickname. |
SEND_MESSAGES | Send messages | Allows sending messages in text channels. |
SEND_MESSAGES_IN_THREADS | Send messages in threads | Allows posting messages inside threads. |
EMBED_LINKS | Embed links | Allows embedded links in messages. |
ATTACH_FILES | Attach files | Allows uploading files in messages. |
ADD_REACTIONS | Add reactions | Allows reacting to messages with emojis. |
MENTION_EVERYONE | Mention everyone | Allows using @everyone, @here and role mentions. |
USE_EXTERNAL_EMOJIS | Use external emojis | Allows using emojis from other servers. |
USE_EXTERNAL_STICKERS | Use external stickers | Allows using stickers from other servers. |
READ_MESSAGE_HISTORY | Read message history | Allows reading older messages in a channel. |
MANAGE_MESSAGES | Manage messages | Allows deleting and pinning messages. |
MANAGE_THREADS | Manage threads | Allows archiving, locking and deleting threads. |
CREATE_PUBLIC_THREADS | Create public threads | Allows creating public threads. |
CREATE_PRIVATE_THREADS | Create private threads | Allows creating private threads. |
SEND_TTS_MESSAGES | Send TTS messages | Allows sending text-to-speech messages. |
SEND_VOICE_MESSAGES | Send voice messages | Allows sending voice messages. |
SEND_POLLS | Create polls | Allows creating message polls. |
PIN_MESSAGES | Pin messages | Allows pinning and unpinning messages. |
BYPASS_SLOWMODE | Bypass slowmode | Allows sending messages without waiting for the channel's slowmode. |
CONNECT | Connect | Allows joining voice channels. |
SPEAK | Speak | Allows speaking in voice channels. |
STREAM | Video | Allows streaming video and screen-share. |
USE_VAD | Use voice activity | Allows speaking without push-to-talk. |
MUTE_MEMBERS | Mute members | Allows muting other members in voice channels. |
DEAFEN_MEMBERS | Deafen members | Allows deafening other members in voice channels. |
MOVE_MEMBERS | Move members | Allows moving members between voice channels. |
PRIORITY_SPEAKER | Priority speaker | Allows priority speaker mode. |
REQUEST_TO_SPEAK | Request to speak | Allows requesting to speak in stage channels. |
USE_SOUNDBOARD | Use soundboard | Allows using the soundboard in voice channels. |
USE_EXTERNAL_SOUNDS | Use external sounds | Allows using sounds from other servers. |
USE_APPLICATION_COMMANDS | Use application commands | Allows running slash commands and context menus. |
USE_EMBEDDED_ACTIVITIES | Use activities | Allows starting embedded voice activities. |
USE_EXTERNAL_APPS | Use external apps | Allows interacting with apps from other servers. |
Button style
Visual style of a Discord button.
| Value | Name | Details |
|---|---|---|
PRIMARY | Primary (blue) | Highlighted blurple button. |
SECONDARY | Secondary (grey) | Muted grey button. |
SUCCESS | Success (green) | Green button for confirmations. |
DANGER | Danger (red) | Red button for destructive actions. |
LINK | Link | Button that opens an external URL. |
PREMIUM | Premium | Button that links to a premium SKU. |
Text input style
Display style of a modal text input.
| Value | Name | Details |
|---|---|---|
SHORT | Short | Single-line text input. |
PARAGRAPH | Paragraph | Multi-line text input. |
Verification level
Server verification level for new members.
| Value | Name | Details |
|---|---|---|
NONE | None | No verification required. |
LOW | Low | Member must have a verified email. |
MEDIUM | Medium | Member must be on Discord for at least 5 minutes. |
HIGH | High | Member must be on the server for at least 10 minutes. |
VERY_HIGH | Very high | Member must have a verified phone number. |
Explicit content filter
How Discord scans messages for explicit content.
| Value | Name | Details |
|---|---|---|
DISABLED | Disabled | No scanning at all. |
MEMBERS_WITHOUT_ROLES | Members without roles | Scan messages from members without any role. |
ALL_MEMBERS | All members | Scan messages from every member. |
Two-factor requirement
Whether moderation actions require 2FA.
| Value | Name | Details |
|---|---|---|
NONE | Not required | Moderators may act without 2FA. |
ELEVATED | Required | Moderators must have 2FA enabled. |
Default notifications
How members are notified about messages by default.
| Value | Name | Details |
|---|---|---|
ALL_MESSAGES | All messages | Notify on every new message. |
ONLY_MENTIONS | Only mentions | Notify only on mentions. |
Activity type
Kind of bot status activity to display.
| Value | Name | Details |
|---|---|---|
PLAYING | Playing | "Playing X". |
STREAMING | Streaming | "Streaming X" with a Twitch/YouTube URL. |
LISTENING | Listening | "Listening to X". |
WATCHING | Watching | "Watching X". |
CUSTOM | Custom status | Free-form custom status. |
COMPETING | Competing | "Competing in X". |
Presence status
Online status for the bot.
| Value | Name | Details |
|---|---|---|
ONLINE | Online | Shown as online. |
IDLE | Idle | Shown as idle (away). |
DND | Do not disturb | Shown as do not disturb. |
INVISIBLE | Invisible | Appears offline to other users. |
OFFLINE | Offline | The user is offline. |
Event privacy
Who can see a scheduled event.
| Value | Name | Details |
|---|---|---|
GUILD_ONLY | Server only | Visible only to server members. |
Event location type
Where a scheduled event takes place.
| Value | Name | Details |
|---|---|---|
STAGE_INSTANCE | Stage | Inside a stage channel. |
VOICE | Voice channel | Inside a voice channel. |
EXTERNAL | External | At a custom external location. |
Event status
Current state of a scheduled event.
| Value | Name | Details |
|---|---|---|
SCHEDULED | Scheduled | The event has not yet started. |
ACTIVE | Active | The event is currently running. |
COMPLETED | Completed | The event has ended. |
CANCELED | Cancelled | The event was cancelled. |
AutoMod event
Which event an AutoMod rule listens to.
| Value | Name | Details |
|---|---|---|
MESSAGE_SEND | Message send | Triggers when a message is sent. |
MEMBER_UPDATE | Member update | Triggers when a member's profile is updated. |
AutoMod trigger
How an AutoMod rule decides to fire.
| Value | Name | Details |
|---|---|---|
KEYWORD | Keyword | Match a list of keywords. |
SPAM | Spam | Discord's built-in spam detection. |
KEYWORD_PRESET | Keyword preset | Match against Discord's preset keyword sets. |
MENTION_SPAM | Mention spam | Trigger on excessive mentions in a single message. |
MEMBER_PROFILE | Member profile | Match against member profile content. |
Stage privacy
Who can join a stage instance.
| Value | Name | Details |
|---|---|---|
PUBLIC | Public | Open to everyone (deprecated by Discord). |
GUILD_ONLY | Server only | Open only to server members. |
Message match
How the message-created trigger matches a message.
| Value | Name | Details |
|---|---|---|
ANY | Any message | Fire on every message. |
CONTAINS | Contains | Fire when the message contains the pattern. |
EQUALS | Equals | Fire when the message exactly equals the pattern. |
STARTS_WITH | Starts with | Fire when the message starts with the pattern. |
ENDS_WITH | Ends with | Fire when the message ends with the pattern. |
REGEX | Regex | Fire when the message matches the regex. |
Audit log event
A specific kind of audit log entry.
| Value | Name | Details |
|---|---|---|
GUILD_UPDATE | Server updated | Server settings were changed. |
CHANNEL_CREATE | Channel created | A channel was created. |
CHANNEL_UPDATE | Channel updated | A channel was updated. |
CHANNEL_DELETE | Channel deleted | A channel was deleted. |
CHANNEL_OVERWRITE_CREATE | Permission overwrite created | A channel permission overwrite was added. |
CHANNEL_OVERWRITE_UPDATE | Permission overwrite updated | A channel permission overwrite was updated. |
CHANNEL_OVERWRITE_DELETE | Permission overwrite deleted | A channel permission overwrite was removed. |
MEMBER_KICK | Member kicked | A member was kicked. |
MEMBER_PRUNE | Members pruned | Inactive members were pruned. |
MEMBER_BAN_ADD | Member banned | A member was banned. |
MEMBER_BAN_REMOVE | Member unbanned | A member was unbanned. |
MEMBER_UPDATE | Member updated | A member's profile was updated. |
MEMBER_ROLE_UPDATE | Member roles updated | A member's roles were changed. |
MEMBER_MOVE | Member moved | A member was moved between voice channels. |
MEMBER_DISCONNECT | Member disconnected | A member was disconnected from voice. |
BOT_ADD | Bot added | A bot was added to the server. |
ROLE_CREATE | Role created | A role was created. |
ROLE_UPDATE | Role updated | A role was updated. |
ROLE_DELETE | Role deleted | A role was deleted. |
INVITE_CREATE | Invite created | An invite was created. |
INVITE_UPDATE | Invite updated | An invite was updated. |
INVITE_DELETE | Invite deleted | An invite was deleted. |
WEBHOOK_CREATE | Webhook created | A webhook was created. |
WEBHOOK_UPDATE | Webhook updated | A webhook was updated. |
WEBHOOK_DELETE | Webhook deleted | A webhook was deleted. |
EMOJI_CREATE | Emoji created | An emoji was uploaded. |
EMOJI_UPDATE | Emoji updated | An emoji was renamed. |
EMOJI_DELETE | Emoji deleted | An emoji was deleted. |
MESSAGE_DELETE | Message deleted | A message was deleted by a moderator. |
MESSAGE_BULK_DELETE | Messages bulk-deleted | Messages were bulk-deleted. |
MESSAGE_PIN | Message pinned | A message was pinned. |
MESSAGE_UNPIN | Message unpinned | A message was unpinned. |
INTEGRATION_CREATE | Integration created | An integration was added. |
INTEGRATION_UPDATE | Integration updated | An integration was updated. |
INTEGRATION_DELETE | Integration deleted | An integration was removed. |
STAGE_INSTANCE_CREATE | Stage started | A stage instance was started. |
STAGE_INSTANCE_UPDATE | Stage updated | A stage instance was updated. |
STAGE_INSTANCE_DELETE | Stage ended | A stage instance was ended. |
STICKER_CREATE | Sticker created | A sticker was uploaded. |
STICKER_UPDATE | Sticker updated | A sticker was updated. |
STICKER_DELETE | Sticker deleted | A sticker was deleted. |
GUILD_SCHEDULED_EVENT_CREATE | Event created | A scheduled event was created. |
GUILD_SCHEDULED_EVENT_UPDATE | Event updated | A scheduled event was updated. |
GUILD_SCHEDULED_EVENT_DELETE | Event deleted | A scheduled event was deleted. |
THREAD_CREATE | Thread created | A thread was created. |
THREAD_UPDATE | Thread updated | A thread was updated. |
THREAD_DELETE | Thread deleted | A thread was deleted. |
AUTO_MODERATION_RULE_CREATE | AutoMod rule created | An AutoMod rule was created. |
AUTO_MODERATION_RULE_UPDATE | AutoMod rule updated | An AutoMod rule was updated. |
AUTO_MODERATION_RULE_DELETE | AutoMod rule deleted | An AutoMod rule was deleted. |
AUTO_MODERATION_BLOCK_MESSAGE | AutoMod blocked message | AutoMod blocked a message. |
AUTO_MODERATION_FLAG_TO_CHANNEL | AutoMod flagged message | AutoMod flagged a message to the alert channel. |
AUTO_MODERATION_USER_COMMUNICATION_DISABLED | AutoMod timed member out | AutoMod timed a member out. |
AUTO_MODERATION_QUARANTINE_USER | AutoMod quarantined member | AutoMod quarantined a member. |
APPLICATION_COMMAND_PERMISSION_UPDATE | Command permissions updated | Someone changed who may use an application command. |
SOUNDBOARD_SOUND_CREATE | Soundboard sound created | Someone added a soundboard sound. |
SOUNDBOARD_SOUND_UPDATE | Soundboard sound updated | Someone changed a soundboard sound. |
SOUNDBOARD_SOUND_DELETE | Soundboard sound deleted | Someone removed a soundboard sound. |
CREATOR_MONETIZATION_REQUEST_CREATED | Monetization requested | Someone applied for creator monetization. |
CREATOR_MONETIZATION_TERMS_ACCEPTED | Monetization terms accepted | Someone accepted the creator monetization terms. |
ONBOARDING_PROMPT_CREATE | Onboarding question created | Someone added a question to onboarding. |
ONBOARDING_PROMPT_UPDATE | Onboarding question updated | Someone changed an onboarding question. |
ONBOARDING_PROMPT_DELETE | Onboarding question deleted | Someone removed an onboarding question. |
ONBOARDING_CREATE | Onboarding set up | Someone set up onboarding for the server. |
ONBOARDING_UPDATE | Onboarding updated | Someone changed the server's onboarding settings. |
HOME_SETTINGS_CREATE | Server Guide set up | Someone set up the Server Guide. |
HOME_SETTINGS_UPDATE | Server Guide updated | Someone changed the Server Guide. |
Overwrite target type
Whether a permission overwrite applies to a role or to a specific server member.
| Value | Name | Details |
|---|---|---|
ROLE | Role | The overwrite applies to a role. |
MEMBER | Member | The overwrite applies to an individual server member. |
Mention kind
Whether a Discord mention refers to a user, a role, or a channel.
| Value | Name | Details |
|---|---|---|
USER | User | A user mention (<@id> or <@!id>). |
ROLE | Role | A role mention (<@&id>). |
CHANNEL | Channel | A channel mention (<#id>). |
Video quality mode
Camera video quality mode for a voice channel.
| Value | Name | Details |
|---|---|---|
AUTO | Auto | Discord chooses the optimal video quality automatically. |
FULL | Full (720p) | Force a constant 720p video quality. |
Sort order
Default ordering for posts inside a forum or media channel.
| Value | Name | Details |
|---|---|---|
LATEST_ACTIVITY | Latest Activity | Sort posts by the most recent activity. |
CREATION_DATE | Creation Date | Sort posts by their creation date. |
Forum layout
Default visual layout used to display posts in a forum channel.
| Value | Name | Details |
|---|---|---|
NOT_SET | Not Set | Let Discord pick the default layout. |
LIST_VIEW | List View | Display posts as a compact list. |
GALLERY_VIEW | Gallery View | Display posts as a grid of media tiles. |
Auto archive duration
How long without activity before threads are auto-archived (in minutes).
| Value | Name | Details |
|---|---|---|
60 | 1 Hour | Archive threads after one hour of inactivity. |
1440 | 1 Day | Archive threads after 24 hours of inactivity. |
4320 | 3 Days | Archive threads after 3 days of inactivity. |
10080 | 1 Week | Archive threads after 7 days of inactivity. |
Channel flag
Bit-flags that toggle individual channel features.
| Value | Name | Details |
|---|---|---|
PINNED | Pinned | The thread is pinned at the top of its parent forum. |
REQUIRE_TAG | Require Tag | Posts in this forum must include at least one tag. |
HIDE_MEDIA_DOWNLOAD_OPTIONS | Hide Media Download Options | Hide media download options for embeds in this channel. |
System channel flag
A flag controlling which system messages are suppressed in a server's system channel.
| Value | Name | Details |
|---|---|---|
SUPPRESS_JOIN_NOTIFICATIONS | Suppress join notifications | Hide member join messages in the system channel. |
SUPPRESS_PREMIUM_SUBSCRIPTIONS | Suppress premium subscriptions | Hide server boost messages in the system channel. |
SUPPRESS_GUILD_REMINDER_NOTIFICATIONS | Suppress server reminders | Hide server setup tip notifications in the system channel. |
SUPPRESS_JOIN_NOTIFICATION_REPLIES | Suppress join notification stickers | Hide the wave sticker reply prompt on join messages. |
SUPPRESS_ROLE_SUBSCRIPTION_PURCHASE_NOTIFICATIONS | Suppress role subscription purchases | Hide role subscription purchase notifications in the system channel. |
SUPPRESS_ROLE_SUBSCRIPTION_PURCHASE_NOTIFICATION_REPLIES | Suppress role subscription replies | Hide reply prompts on role subscription purchase notifications. |
AutoMod action type
The kind of action AutoMod takes when a rule is triggered.
| Value | Name | Details |
|---|---|---|
BLOCK_MESSAGE | Block message | Block the offending message and optionally show a custom message to the author. |
SEND_ALERT_MESSAGE | Send alert message | Send an alert about the trigger to a designated channel. |
TIMEOUT | Timeout member | Time the member out for a specified duration. |
BLOCK_MEMBER_INTERACTION | Block member interaction | Prevent the member from interacting with others until they edit or delete the message. |
AutoMod keyword preset
Discord-maintained word lists used by keyword preset triggers.
| Value | Name | Details |
|---|---|---|
PROFANITY | Profanity | Words considered swearing or cursing. |
SEXUAL_CONTENT | Sexual content | Words referring to sexually explicit behavior or activity. |
SLURS | Slurs | Personal insults or words used as discriminatory slurs. |
Application command type
The type of an application command (slash, user context, message context, or primary entry point).
| Value | Name | Details |
|---|---|---|
CHAT_INPUT | Slash command | A standard chat-input slash command. |
USER | User context menu | A user-targeted context menu command. |
MESSAGE | Message context menu | A message-targeted context menu command. |
PRIMARY_ENTRY_POINT | Primary entry point | The primary launch entry point for an Activity. |
Slash command option type
The data type of a slash command option.
| Value | Name | Details |
|---|---|---|
SUB_COMMAND | Sub command | A nested sub command. |
SUB_COMMAND_GROUP | Sub command group | A group of sub commands. |
STRING | Text | Text input. |
INTEGER | Whole number | Whole number input. |
BOOLEAN | Yes/No | Yes/No input. |
USER | User | A Discord user. |
MEMBER | Server member | A server member. Registered with Discord as a user option, but the flow always receives a fetched server member (the command fails if the picked user is not in the server). |
CHANNEL | Channel | A server channel. |
ROLE | Role | A server role. |
MENTIONABLE | Either User or Role | A user or role. |
NUMBER | Decimal number | Decimal number input. |
ATTACHMENT | Attachment | A file attachment. |
Dropdown type
The kind of dropdown component.
| Value | Name | Details |
|---|---|---|
STRING | Dropdown | A dropdown with custom options. |
USER | User dropdown | A dropdown of users. |
ROLE | Role dropdown | A dropdown of roles. |
CHANNEL | Channel dropdown | A dropdown of channels. |
MENTIONABLE | User-or-role dropdown | A dropdown of users and roles. |
Form field type
The kind of field a pop-up form (modal) shows the member.
| Value | Name | Details |
|---|---|---|
TEXT_INPUT | Text input | A single text box the member types into. |
STRING_SELECT | Dropdown | A dropdown where the member picks from options you define. |
USER_SELECT | Member picker | A dropdown where the member picks one or more members. |
ROLE_SELECT | Role picker | A dropdown where the member picks one or more roles. |
CHANNEL_SELECT | Channel picker | A dropdown where the member picks one or more channels. |
MENTIONABLE_SELECT | Member or role picker | A dropdown where the member picks members or roles. |
CHECKBOX | Checkbox | A single yes/no tickbox, for example agreeing to the rules. |
CHECKBOX_GROUP | Checkbox group | A list of tickboxes where one or more options can be picked. |
RADIO_GROUP | Radio group | A list where exactly one option can be picked. |
FILE_UPLOAD | File upload | Lets the member attach one or more files. |
TEXT_DISPLAY | Text display | Read-only text shown in the form. It collects no answer. |
Entitlement type
The type of an entitlement (premium SKU purchase, gift, subscription, etc.).
| Value | Name | Details |
|---|---|---|
APPLICATION_SUBSCRIPTION | App subscription | A recurring subscription to this bot, billed by Discord. |
PURCHASE | One-time purchase | The member bought this item once and keeps it. |
PREMIUM_SUBSCRIPTION | Nitro subscription | The member has it because they subscribe to Discord Nitro. |
DEVELOPER_GIFT | Gift from the developer | Handed out for free by the people who made the bot. |
TEST_MODE_PURCHASE | Test purchase | Created for testing. No real money was paid. |
FREE_PURCHASE | Free item | The member claimed this item while it cost nothing. |
USER_GIFT | Gift from another member | Someone else bought this item and gifted it to the member. |
PREMIUM_PURCHASE | Free for Nitro members | The member claimed this item for free as a Discord Nitro subscriber. |
Flow parameter type
Type of a declared flow parameter or return value. Only serializable value types are allowed - scheduled runs persist arguments and re-resolve server entities when they fire.
| Value | Name | Details |
|---|---|---|
STRING | Text | Any text, such as a name, a reason or a whole message. |
INTEGER | Whole number | A whole number with no decimals, such as 5 or -12. |
FLOAT | Number | A number that may have decimals, such as 2.5. |
BOOLEAN | Yes/No | A simple yes-or-no value. |
SNOWFLAKE | Discord ID | The long number Discord uses to identify a user, channel, role or message. |
URL | URL | A web address, starting with http:// or https://. |
COLOR | Color | A color, written as a hex code such as #5865F2. |
DATETIME | Date & time | A specific moment in time, with both a date and a clock time. |
DURATION | Duration | A length of time, such as 10 minutes or 2 days. |
DISCORD_USER | Discord user | A Discord account. Works even for people who are not on your server. |
GUILD_MEMBER | Server member | Someone who is on your server, including their nickname and roles. |
GUILD_CHANNEL | Server channel | A channel on your server. |
GUILD_ROLE | Server role | A role on your server. |
ID | ID | An identifier kept exactly as written, such as a Discord ID or an id from another service. |
BIGINT | Big whole number | A whole number of any size, kept exact. |
ARRAY | List | A list of values. Choose what each item is in Content type. |
MAP | Lookup table | Values looked up by text keys. Choose what each value is in Content type. |
Component type
Identifies the kind of Discord message component (Components V2).
| Value | Name | Details |
|---|---|---|
ACTION_ROW | Action Row | A row container for buttons or a single dropdown. |
BUTTON | Button | A clickable button component. |
STRING_SELECT | Dropdown | A dropdown with predefined options. |
TEXT_INPUT | Text Input | A text input field used inside modals. |
USER_SELECT | User dropdown | A dropdown populated with users. |
ROLE_SELECT | Role dropdown | A dropdown populated with roles. |
MENTIONABLE_SELECT | User-or-role dropdown | A dropdown populated with users and roles. |
CHANNEL_SELECT | Channel dropdown | A dropdown populated with channels. |
SECTION | Section | A V2 section grouping text with an accessory. |
TEXT_DISPLAY | Text Display | A V2 text display component. |
THUMBNAIL | Thumbnail | A V2 thumbnail component used as a section accessory. |
MEDIA_GALLERY | Media Gallery | A V2 gallery of up to 10 media items. |
FILE | File | A V2 file attachment component. |
SEPARATOR | Separator | A V2 spacing separator with optional divider line. |
CONTAINER | Container | A V2 container that groups other components with an accent color. |
Separator spacing
Controls the vertical spacing applied by a separator component.
| Value | Name | Details |
|---|---|---|
SMALL | Small | Small gap between adjacent components. |
LARGE | Large | Large gap between adjacent components. |
Application flag
A public flag describing capabilities or settings of a Discord application.
| Value | Name | Details |
|---|---|---|
EMBEDDED | Embedded | The application is embedded within the Discord client (Activity). |
GATEWAY_PRESENCE | Gateway Presence | Approved to receive presence updates over the gateway. |
GATEWAY_PRESENCE_LIMITED | Gateway Presence (Limited) | Awaiting approval to receive presence updates over the gateway. |
GATEWAY_GUILD_MEMBERS | Gateway Server Members | Approved to receive server members events over the gateway. |
GATEWAY_GUILD_MEMBERS_LIMITED | Gateway Server Members (Limited) | Awaiting approval to receive server members events over the gateway. |
VERIFICATION_PENDING_GUILD_LIMIT | Verification Pending Server Limit | Hit the unusual growth criteria preventing verification. |
EMBEDDED_FIRST_PARTY | Embedded First Party | The embedded application is built by Discord itself. |
GATEWAY_MESSAGE_CONTENT | Gateway Message Content | Approved to receive message content over the gateway. |
GATEWAY_MESSAGE_CONTENT_LIMITED | Gateway Message Content (Limited) | Awaiting approval to receive message content over the gateway. |
APPLICATION_COMMAND_BADGE | Application Command Badge | The application has registered global application commands. |
ACTIVE_DEVELOPER | Active Developer | The application owner has the Active Developer badge. |
EMBEDDED_RELEASED | Embedded (released) | The application's Activity is released to everyone. |
MANAGED_EMOJI | Managed emoji | Discord marks the application as able to use managed emojis. |
EMBEDDED_IAP | Embedded in-app purchases | The application's Activity can offer in-app purchases. |
GROUP_DM_CREATE | Create group DMs | The application can create group direct messages. |
APPLICATION_AUTO_MODERATION_RULE_CREATE_BADGE | AutoMod badge | The application has created enough AutoMod rules to show the AutoMod badge. |
RPC_HAS_CONNECTED | Has used RPC | The application has connected to the Discord client through RPC. |
SKU type
The category of a Discord SKU.
| Value | Name | Details |
|---|---|---|
DURABLE | Durable | A one-time purchase that does not get consumed. |
CONSUMABLE | Consumable | A one-time purchase that is consumed by the application. |
SUBSCRIPTION | Subscription | A recurring subscription. |
SUBSCRIPTION_GROUP | Subscription Group | A system-generated group containing related subscription SKUs. |
Subscription status
The current status of a Discord subscription.
| Value | Name | Details |
|---|---|---|
ACTIVE | Active | The subscription is active and renewing. |
ENDING | Ending | The subscription is active until the end of the current period. |
INACTIVE | Inactive | The subscription is no longer active. |
Role connection metadata type
Comparison operator used by Discord to evaluate role connection metadata against role requirements.
| Value | Name | Details |
|---|---|---|
INTEGER_LESS_THAN_OR_EQUAL | Whole number <= Server Value | Metadata value (whole number) is less than or equal to the server's configured value. |
INTEGER_GREATER_THAN_OR_EQUAL | Whole number >= Server Value | Metadata value (whole number) is greater than or equal to the server's configured value. |
INTEGER_EQUAL | Whole number = Server Value | Metadata value (whole number) equals the server's configured value. |
INTEGER_NOT_EQUAL | Whole number != Server Value | Metadata value (whole number) does not equal the server's configured value. |
DATETIME_LESS_THAN_OR_EQUAL | DateTime <= Server Value | Metadata value (datetime) is less than or equal to the server's configured value, in days. |
DATETIME_GREATER_THAN_OR_EQUAL | DateTime >= Server Value | Metadata value (datetime) is greater than or equal to the server's configured value, in days. |
BOOLEAN_EQUAL | Yes/No = Server Value | Metadata value (yes/no) equals the server's configured value. |
BOOLEAN_NOT_EQUAL | Yes/No != Server Value | Metadata value (yes/no) does not equal the server's configured value. |
Entitlement owner type
Indicates whether a test entitlement is owned by a server or a user.
| Value | Name | Details |
|---|---|---|
GUILD | Server | The entitlement is owned by a server (server-wide). |
USER | User | The entitlement is owned by a single user. |
Onboarding prompt type
The interaction style used by an onboarding prompt.
| Value | Name | Details |
|---|---|---|
MULTIPLE_CHOICE | Multiple Choice | Prompt rendered as a set of selectable buttons or cards. |
DROPDOWN | Dropdown | Prompt rendered as a dropdown list. |
Onboarding mode
Controls which channels and roles count toward Discord's onboarding requirements.
| Value | Name | Details |
|---|---|---|
ONBOARDING_DEFAULT | Default | Counts only default channels toward onboarding constraints. |
ONBOARDING_ADVANCED | Advanced | Counts default channels and channels referenced in prompts toward onboarding constraints. |
Application command permission type
Determines what kind of entity an application command permission overwrite targets.
| Value | Name | Details |
|---|---|---|
ROLE | Role | Permission targets a specific role. |
USER | User | Permission targets a specific user. |
CHANNEL | Channel | Permission targets a specific channel (or all channels via the @everyone-channel sentinel). |
Sort direction
Direction entries are sorted in.
| Value | Name | Details |
|---|---|---|
ASC | Ascending | Smallest values first. |
DESC | Descending | Largest values first. |
Aggregate operation
Which aggregate to compute over a field's values.
| Value | Name | Details |
|---|---|---|
SUM | Sum | Total of all numeric values. |
AVG | Average | Mean of all numeric values. |
COUNT | Count | Number of entries. |
MIN | Minimum | Smallest numeric value. |
MAX | Maximum | Largest numeric value. |
MEDIAN | Median | Middle numeric value. |
Pick weighting
How entries are weighted when drawing at random.
| Value | Name | Details |
|---|---|---|
NONE | Uniform | Every key is equally likely. |
VALUE | By value | More likely the higher the entry's value (a raffle by ticket count). |
Comparison
How the current value is compared to a threshold.
| Value | Name | Details |
|---|---|---|
GTE | At least (≥) | Current value is greater than or equal to the threshold. |
GT | Greater than (>) | Current value is strictly greater than the threshold. |
LTE | At most (≤) | Current value is less than or equal to the threshold. |
LT | Less than (<) | Current value is strictly less than the threshold. |
EQ | Equal to (=) | Current value equals the threshold. |
Condition
What must be true of the currently stored value for the new value to be written.
| Value | Name | Details |
|---|---|---|
ABSENT | Only if nothing is stored | Writes only when the field is still empty for this subject or key. This is how you build a lock: the first run gets "Applied" = true, everyone after it gets false. |
PRESENT | Only if something is stored | Writes only when there already is a value. Use it to update an existing entry without ever creating a new one. |
EQUALS | Only if it equals | Writes only when the stored value is exactly the expected value. This is the safe way to change a value you read a moment ago: if somebody else changed it in between, nothing is written. |
NOT_EQUALS | Only if it does not equal | Writes only when the stored value differs from the expected value, so an entry that already says this is left alone. |
Duration style
How a duration is rendered as text.
| Value | Name | Details |
|---|---|---|
COMPACT | Compact | Short letter units, e.g. "2h 30m". |
LONG | Long | Spelled-out units, e.g. "2 hours 30 minutes". |
LARGEST_UNIT | Largest unit | Only the largest unit, e.g. "3 hours". |
Number style
How a number is rendered as text.
| Value | Name | Details |
|---|---|---|
GROUPED | Grouped | Thousands separators, e.g. "4,000,000". |
COMPACT | Compact | Abbreviated units, e.g. "4M". |
COMPACT_LONG | Compact (long) | Spelled-out units, e.g. "4 million". |
Timestamp style
How Discord shows a date and time. Each reader sees it in their own time zone and language.
| Value | Name | Details |
|---|---|---|
t | Short time | The time only, e.g. "16:20". |
T | Long time | The time with seconds, e.g. "16:20:30". |
d | Short date | The date in digits, e.g. "20/04/2021". |
D | Long date | The date with the month written out, e.g. "20 April 2021". |
f | Short date and time | Date and time, e.g. "20 April 2021 16:20". |
F | Long date and time | Weekday, date and time, e.g. "Tuesday, 20 April 2021 16:20". |
R | Relative | How long ago or how far ahead, e.g. "in 2 hours" or "3 days ago". It counts live. |
Widget image style
How the server widget image looks.
| Value | Name | Details |
|---|---|---|
shield | Shield | A small badge with the Discord logo and the number of members online. |
banner1 | Banner 1 | A large banner with the server icon, name and members online, and "Powered by Discord" at the bottom. |
banner2 | Banner 2 | A smaller banner with the server icon, name and members online, and the Discord logo on the right. |
banner3 | Banner 3 | A large banner with the server icon, name and members online, and a "Chat now" link at the bottom. |
banner4 | Banner 4 | A large banner with the Discord logo on top, the server icon, name and members online, and a "Join my server" button. |
Mention type
What kind of thing an id points at, which decides the mention markup.
| Value | Name | Details |
|---|---|---|
USER | User | A member or user, mentioned as <@123>. |
ROLE | Role | A server role, mentioned as <@&123>. |
CHANNEL | Channel | A channel, linked as <#123>. |
Component cleanup
What happens to the watched buttons/dropdowns once a wait finishes.
| Value | Name | Details |
|---|---|---|
DISABLE | Disable | Keep the components visible but greyed out. |
REMOVE | Remove | Remove the components from the message. |
KEEP | Keep | Leave the components untouched. |
RESET | Reset | Clear a dropdown's selection so it shows its placeholder again and can be picked again. |
Error code
Machine-readable code describing why an action failed.
| Value | Name | Details |
|---|---|---|
MISSING_PERMISSIONS | Missing permissions | The bot lacks the required permissions. |
DISCORD_API_ERROR | Discord API error | Discord rejected the request. |
INVALID_INPUT | Invalid input | An input had an invalid value. |
NOT_FOUND | Not found | The requested resource does not exist. |
STORAGE_ERROR | Storage error | A storage operation failed. |
LIMIT_EXCEEDED | Limit exceeded | An execution limit was exceeded. |
TIMEOUT | Timeout | The operation took too long. |
UNKNOWN | Unknown | An unexpected error occurred. |
INTERACTION_EXPIRED | Interaction expired | The interaction expired before the bot responded (roughly a 3-second window). Defer or reply sooner, or use the defer guard. |
AI_CREDITS_EXHAUSTED | Out of AI Coins | This server has no AI Coins left, so the AI action did not run. Nothing was charged. Catch this code to fall back, or top up your AI Coins. |
HTTP_TIMEOUT | HTTP timeout | The web API did not answer in time. |
HTTP_UNREACHABLE | HTTP unreachable | The web API could not be reached: the address does not exist, refused the connection or has a broken certificate. |
HTTP_RESPONSE_TOO_LARGE | HTTP response too large | The answer was larger than 1 MB. |
HTTP_RATE_LIMITED | HTTP rate limited | Too many requests in a short time. Try again later. |
HTTP_UNAVAILABLE | HTTP unavailable | Outgoing requests are not available right now. |
HTTP method
How an HTTP request treats the address.
| Value | Name | Details |
|---|---|---|
GET | GET | Read data. |
POST | POST | Send new data. |
PUT | PUT | Replace data. |
PATCH | PATCH | Change part of the data. |
DELETE | DELETE | Delete data. |
Body
What an HTTP request or webhook answer sends along.
| Value | Name | Details |
|---|---|---|
NONE | None | Send no body. |
JSON | JSON | Send a value as JSON. |
FORM | Form | Send names and values as a URL-encoded form. |
RAW | Text | Send text exactly as written. |
Kind of value
Which kind of value an action works with, so the flow editor knows what you can plug in and what comes back out.
| Value | Name | Details |
|---|---|---|
STRING | Text | Any text, such as a name, a reason or a whole message. |
FLOAT | Number | A number, with or without decimals. |
BOOLEAN | Yes/No | A simple yes-or-no value. |
DISCORD_USER | Discord user | A Discord account. Works even for people who are not on your server. |
GUILD_MEMBER | Server member | Someone who is on your server, including their nickname and roles. |
GUILD_ROLE | Server role | A role on your server. |
GUILD_CHANNEL | Server channel | A channel on your server. |
ID | ID | An identifier kept exactly as written, such as a Discord ID or an id from another service. |
BIGINT | Big whole number | A whole number of any size, kept exact. Calculate with it using the big-number actions. |
Large whole number operation
What to do with two big whole numbers.
| Value | Name | Details |
|---|---|---|
ADD | Add | a plus b. |
SUBTRACT | Subtract | a minus b. |
MULTIPLY | Multiply | a times b. |
DIVIDE | Divide | a divided by b, rounded toward zero. Dividing by zero fails. |
MODULO | Remainder | What is left after dividing a by b; it has the sign of a. Dividing by zero fails. |
Time window
A trailing time window for counting flow runs.
| Value | Name | Details |
|---|---|---|
ALL | All time | Count every recorded run (subject to retention). |
DAY | Last 24 hours | Count runs from the last 24 hours. |
WEEK | Last 7 days | Count runs from the last 7 days. |
Character set
Which characters random text may contain.
| Value | Name | Details |
|---|---|---|
ALPHANUMERIC | Letters and digits | A-Z, a-z and 0-9. |
ALPHABETIC | Letters only | A-Z and a-z. |
NUMERIC | Digits only | 0-9. |
HEXADECIMAL | Hexadecimal | 0-9 and a-f. |
Thread privacy
Whether to fetch public or private archived threads.
| Value | Name | Details |
|---|---|---|
PUBLIC | Public | Public archived threads. |
PRIVATE | Private | Private archived threads. |
Objects
Things such as channels, members or messages. Each has fields you can read in your flow.
Channel
A Discord channel.
Example: #general.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | The Discord ID of the channel. Example: 345678901234567890. |
| Name | Text | The name of the channel. May be empty. Example: general. |
| Type | Channel type | The kind of channel. |
| URL | URL | Jump-to URL of the channel. |
| Created at | Date and time | When the channel was created. May be empty. |
Server channel
A channel that lives on a server.
Example: #general. Builds on: Channel.
| Property | Type | Details |
|---|---|---|
| Server | Server | The server this channel belongs to. |
| Category | Category | The category this channel sits in. May be empty. |
| Position | Whole number | Position of the channel in the channel list. |
| Permissions synced | Yes/No | Whether permissions are synced with the parent category. May be empty. |
| Manageable | Yes/No | Whether the bot can manage this channel. |
| Viewable | Yes/No | Whether the bot can see this channel. |
| Deletable | Yes/No | Whether the bot can delete this channel. |
Category
A category that groups channels.
Builds on: Server channel.
| Property | Type | Details |
|---|---|---|
| Channels | List of Server channel | Channels inside this category. |
Text channel
A text channel on your server.
Builds on: Server channel.
| Property | Type | Details |
|---|---|---|
| Topic | Text | The channel topic. Maximum length: 1024 characters. May be empty. |
| NSFW | Yes/No | Whether this channel is marked age-restricted. |
| Slowmode | Duration | Rate limit per user. |
| Default auto-archive | Duration | Default auto-archive duration for new threads. May be empty. |
| Default thread slowmode | Duration | Default slowmode for new threads in this channel. May be empty. |
| Last message | Message | The most recent message sent in this channel. May be empty. |
Announcement channel
An announcement channel that members can follow.
Builds on: Text channel.
Voice channel
A voice channel on your server.
Builds on: Server channel.
| Property | Type | Details |
|---|---|---|
| Bitrate | Whole number | Audio bitrate (8000 - 384000). Value: 8000 to 384000. |
| User limit | Whole number | Maximum number of users (0 = unlimited). Value: 0 to 99. |
| RTC region | Text | Voice region override. May be empty. |
| Members in voice | List of Server member | Members currently connected to this voice channel. |
| Full | Yes/No | Whether the user limit is reached. |
| Joinable | Yes/No | Whether the bot can join this channel. |
| Speakable | Yes/No | Whether the bot can speak in this channel. |
Stage channel
A stage channel for moderated audio events.
Builds on: Voice channel.
| Property | Type | Details |
|---|---|---|
| Active stage | Stage instance | The currently running stage instance, if any. May be empty. |
| Topic | Text | Topic of the channel. May be empty. |
Forum tag
A tag that can be applied to forum posts.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | ID of the tag. |
| Name | Text | Display name of the tag. Maximum length: 20 characters. |
| Moderator only | Yes/No | Whether only moderators can apply this tag. |
| Emoji | Text | Emoji shown next to the tag. May be empty. |
Forum channel
A forum channel containing posts as threads.
Builds on: Server channel.
| Property | Type | Details |
|---|---|---|
| Topic | Text | Channel topic. Maximum length: 4096 characters. May be empty. |
| NSFW | Yes/No | Whether this forum is age-restricted. |
| Available tags | List of Forum tag | Tags that can be applied to posts. Maximum items: 20. |
| Default auto-archive | Duration | Default auto-archive duration for new posts. May be empty. |
| Default post slowmode | Duration | Default slowmode for new posts. May be empty. |
Media channel
A media channel that behaves like a forum.
Builds on: Forum channel.
Thread
A thread inside a text or forum channel.
Builds on: Server channel.
| Property | Type | Details |
|---|---|---|
| Owner | Server member | Member that started the thread. May be empty. |
| Parent channel | Server channel | The channel this thread lives in. May be empty. |
| Archived | Yes/No | Whether the thread is archived. May be empty. |
| Locked | Yes/No | Whether the thread is locked. May be empty. |
| Auto-archive | Duration | When the thread auto-archives. May be empty. |
| Archived at | Date and time | When the thread was last archived. May be empty. |
| Invitable | Yes/No | Whether non-moderators can invite to a private thread. May be empty. |
| Joined | Yes/No | Whether the bot has joined this thread. |
| Member count | Whole number | Number of members in the thread. May be empty. |
| Message count | Whole number | Approximate number of messages in the thread. May be empty. |
| Applied tags | List of Forum tag | Forum tags applied to this post. |
Direct message
A direct message channel.
Builds on: Channel.
| Property | Type | Details |
|---|---|---|
| Recipient | User | User the bot is talking to. May be empty. |
User
A Discord user account.
Example: Alex (@alex).
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Discord ID of the user. Example: 123456789012345678. |
| Username | Text | Login username. Example: alex. |
| Global name | Text | Discord display name (may be empty). May be empty. |
| Display name | Text | The user's display name (global name, or the username if empty). Example: Alex. |
| Discriminator | Text | Legacy discriminator ("0" for migrated users). |
| Avatar URL | URL | URL of the user's avatar. May be empty. |
| Banner URL | URL | URL of the user's banner. May be empty. |
| Accent color | Color | Profile accent color. May be empty. |
| Is bot | Yes/No | Whether the user is a bot. |
| Is Discord system | Yes/No | Whether the user is a Discord system account. |
| Tag | Text | Username with discriminator (legacy format). |
| Mention | Text | Mention text for use in messages. Example: @Alex. |
| Created at | Date and time | When the account was created. |
Server member
A user in the context of a specific server.
Example: Alex on this server. Builds on: User.
| Property | Type | Details |
|---|---|---|
| Server | Server | Server this member belongs to. |
| Nickname | Text | Server nickname (may be empty). Maximum length: 32 characters. May be empty. Example: Lexi. |
| Display name | Text | Best display name (nickname > global > username). Example: Alex. |
| Display avatar | URL | Best display avatar URL. |
| Display color | Color | Color from the highest-coloured role. |
| Joined at | Date and time | When the member joined the server. May be empty. |
| Boosting since | Date and time | When the member started boosting the server. May be empty. |
| Timeout until | Date and time | When the member's timeout ends. May be empty. |
| Pending screening | Yes/No | Whether the member still needs to pass membership screening. |
| Roles | List of Role | Roles assigned to the member. Example: @Moderators, @Members. |
| Highest role | Role | The member's highest role by position (at minimum @everyone). |
| Permissions | List of Permission | Effective permissions of the member. |
| Kickable | Yes/No | Whether the bot can kick this member. |
| Bannable | Yes/No | Whether the bot can ban this member. |
| Moderatable | Yes/No | Whether the bot can time this member out. |
| Manageable | Yes/No | Whether the bot can manage this member. |
| Voice state | Voice state | Current voice state, if connected. |
Role
A role on your server.
Example: @Moderators.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Role ID. Example: 234567890123456789. |
| Name | Text | Display name of the role. Maximum length: 100 characters. Example: Moderators. |
| Color | Color | Role color. |
| Position | Whole number | Position in the role list. |
| Display separately | Yes/No | Whether members with the role appear separately. |
| Anyone can mention | Yes/No | Whether the role can be @mentioned. |
| Managed | Yes/No | Whether the role is managed by an integration. |
| Icon URL | URL | URL of the role icon. May be empty. |
| Unicode emoji | Text | Unicode emoji used as the role icon. May be empty. |
| Permissions | List of Permission | Permissions granted by the role. |
| Members | List of Server member | Members that have this role. Example: Alex, Sam. |
| Mention | Text | Mention text for use in messages. |
| Created at | Date and time | When the role was created. |
Server
A Discord server.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Server ID. |
| Name | Text | Server name. Maximum length: 100 characters. |
| Description | Text | Server description. May be empty. |
| Icon URL | URL | URL of the server icon. May be empty. |
| Banner URL | URL | URL of the server banner. May be empty. |
| Splash URL | URL | URL of the invite splash image. May be empty. |
| Owner | Server member | Server owner. May be empty. |
| Member count | Whole number | Total number of members. |
| Boost level | Whole number | The server boost level (0-3). |
| Boost count | Whole number | Number of active boosts, or empty when unknown. May be empty. |
| Preferred locale | Text | Server-preferred locale. |
| Verification level | Verification level | Required verification level for new members. |
| Content filter | Explicit content filter | Explicit content filter setting. |
| Default notifications | Default notifications | Default notification setting. |
| 2FA requirement | Two-factor requirement | Whether moderation requires 2FA. |
| Vanity code | Text | Server vanity invite code. May be empty. |
| AFK channel | Voice channel | Channel members are moved to when idle. May be empty. |
| AFK timeout | Duration | Idle time before moving to the AFK channel. May be empty. |
| System channel | Text channel | Channel that receives Discord system messages. May be empty. |
| Rules channel | Text channel | Channel containing server rules. May be empty. |
| Public updates channel | Text channel | Channel that receives public Discord updates. May be empty. |
| Safety alerts channel | Text channel | Channel that receives safety alerts. May be empty. |
| Roles | List of Role | All roles on the server. |
| Channels | List of Server channel | All channels on the server. |
| Members by ID | Lookup table of Discord ID to Server member | Lookup table of member ID to member. |
| Created at | Date and time | When the server was created. |
| Everyone role | Role | The default @everyone role of the server. |
Attachment
A file attached to a message.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Attachment ID. |
| File name | Text | File name as uploaded. |
| Description | Text | Alt text or description. Maximum length: 1024 characters. May be empty. |
| Content type | Text | MIME content type. May be empty. |
| Size | Whole number | File size in bytes. |
| URL | URL | URL of the attachment. |
| Proxy URL | URL | Discord-proxied URL. |
| Height | Whole number | Image height in pixels (if applicable). May be empty. |
| Width | Whole number | Image width in pixels (if applicable). May be empty. |
| Ephemeral | Yes/No | Whether the attachment is part of an ephemeral message. |
| Duration | Duration | Duration of the audio (for voice messages). May be empty. |
Embed field
A name/value field inside an embed.
| Property | Type | Details |
|---|---|---|
| Field name | Text | Bold field title (max 256 characters). Length: 1 to 256 characters. |
| Field value | Text | Field body text (max 1024 characters). Length: 1 to 1024 characters. |
| Inline | Yes/No | Whether the field appears side-by-side. Default: No. |
Embed footer
Footer of an embed.
| Property | Type | Details |
|---|---|---|
| Footer text | Text | Footer text. Length: 1 to 2048 characters. |
| Footer icon URL | URL | Small icon shown next to the footer. May be empty. |
Embed author
Author block of an embed.
| Property | Type | Details |
|---|---|---|
| Author name | Text | Display name of the author. Length: 1 to 256 characters. |
| Author URL | URL | URL the name links to. May be empty. |
| Author icon URL | URL | Small icon shown next to the author. May be empty. |
Embed
A rich embed attached to a message.
| Property | Type | Details |
|---|---|---|
| Title | Text | Embed title (max 256 characters). Maximum length: 256 characters. May be empty. |
| Description | Text | Embed description (max 4096 characters). Maximum length: 4096 characters. May be empty. |
| URL | URL | URL the title links to. May be empty. |
| Color | Color | Side-bar color of the embed. May be empty. |
| Timestamp | Date and time | Footer timestamp. May be empty. |
| Image URL | URL | Large image displayed in the embed. May be empty. |
| Thumbnail URL | URL | Small thumbnail in the top right. May be empty. |
| Footer | Embed footer | Footer of the embed. May be empty. |
| Author | Embed author | Author block of the embed. May be empty. |
| Fields | List of Embed field | Up to 25 name/value fields. Maximum items: 25. Default: []. |
Button
A button attached to a message.
| Property | Type | Details |
|---|---|---|
| Label | Text | Text shown on the button (max 80 characters). Maximum length: 80 characters. May be empty. |
| Emoji | Text | Emoji shown on the button. May be empty. |
| Style | Button style | Visual style. Default: Primary (blue) |
| Disabled | Yes/No | Whether the button is greyed out. Default: No. |
| Custom ID | Text | Optional identifier that rides along with the click (max 80 characters). With a target flow it is exposed there as the interaction's state; without one it becomes the button's raw custom id. Maximum length: 80 characters. May be empty. |
| Target flow | Flow | Flow to run when this button is clicked. Use only one of these: URL. May be empty. |
| URL | URL | URL to open when the button is clicked (link buttons only). Shown when Style is. Use only one of these: Target flow. May be empty. |
Allowed mentions
Controls which mentions in a message actually ping users.
| Property | Type | Details |
|---|---|---|
| Allow @everyone | Yes/No | Whether @everyone and @here may ping. Default: No. |
| Allow role mentions | Yes/No | Whether role mentions may ping. Default: Yes. |
| Allow user mentions | Yes/No | Whether user mentions may ping. Default: Yes. |
| Pingable users | List of User | Specific users that may be pinged (overrides "Allow user mentions"). Maximum items: 100. |
| Pingable roles | List of Role | Specific roles that may be pinged (overrides "Allow role mentions"). Maximum items: 100. |
| Mention replied user | Yes/No | Whether replying to a message pings the original author. Default: Yes. |
Message content
The full payload of a message: text, embeds, buttons and files.
| Property | Type | Details |
|---|---|---|
| Text | Text | Plain text body of the message (max 2000 characters). Maximum length: 2000 characters. May be empty. |
| Embeds | List of Embed | Up to 10 rich embeds. Maximum items: 10. Default: []. |
| Buttons | List of Button | Buttons attached to the message. Maximum items: 25. Default: []. |
| Files | List of Attachment | Files to attach to the message. Maximum items: 10. Default: []. |
| Text-to-speech | Yes/No | Whether the message should be read aloud. Default: No. |
| Ephemeral | Yes/No | Only the recipient sees the message (interactions only). Default: No. |
| Suppress embeds | Yes/No | Hide embeds generated from links. Default: No. |
| Silent message | Yes/No | Send without push notifications. Default: No. |
| Allowed mentions | Allowed mentions | Restrict which mentions actually ping. May be empty. |
Message
A message in a channel.
Example: Hello there, sent by Alex.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Message ID. |
| Text | Text | Raw message content. Example: Hello there. |
| Cleaned text | Text | Content with mentions resolved to display names. |
| Channel | Text channel | Channel the message was sent in. |
| Server | Server | Server the message was sent in (none for DMs). May be empty. |
| Author | User | User that sent the message. Example: Alex (@alex). |
| Author (as member) | Server member | Author resolved to a server member, when applicable. May be empty. |
| Attachments | List of Attachment | Files attached to the message. |
| Embeds | List of Embed | Embeds in the message. |
| Mentioned users | List of User | Users mentioned in the message. |
| Mentioned roles | List of Role | Roles mentioned in the message. |
| Mentioned channels | List of Server channel | Channels mentioned in the message. |
| Mentions everyone | Yes/No | Whether the message contains @everyone or @here. |
| Pinned | Yes/No | Whether the message is pinned. |
| Text-to-speech | Yes/No | Whether the message was sent as TTS. |
| System message | Yes/No | Whether this is a Discord system message. |
| Is Components V2 | Yes/No | Whether the message was sent as a Components V2 message. Such messages can only be edited with Components V2 content. |
| Edited at | Date and time | When the message was last edited. May be empty. |
| Created at | Date and time | When the message was sent. |
| URL | URL | Jump-to URL of the message. |
| Thread | Thread | Thread that was started from this message. May be empty. |
| Replied-to message | Message | Message this one replies to. May be empty. |
| As message content | Message content | The message's content/embeds/components/attachments repackaged as message content, so you can edit, forward or re-send it. |
Voice state
A member's current voice connection state.
| Property | Type | Details |
|---|---|---|
| Member | Server member | The member this voice state belongs to. May be empty. |
| Channel | Voice channel | Voice channel the member is connected to. May be empty. |
| Session ID | Text | Voice session identifier. May be empty. |
| Server deafened | Yes/No | Whether server-deafened by a moderator. May be empty. |
| Server muted | Yes/No | Whether server-muted by a moderator. May be empty. |
| Self deafened | Yes/No | Whether the user has deafened themselves. May be empty. |
| Self muted | Yes/No | Whether the user has muted themselves. May be empty. |
| Camera on | Yes/No | Whether the user has video on. May be empty. |
| Streaming | Yes/No | Whether the user is screen-sharing. May be empty. |
| Suppressed | Yes/No | Whether the user is suppressed (cannot speak in stage). May be empty. |
| Requested to speak at | Date and time | When the user raised their hand in stage. May be empty. |
Stage instance
A live stage event in a stage channel.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Stage instance ID. |
| Server | Server | Server the stage runs on. May be empty. |
| Stage channel | Stage channel | Stage channel hosting the event. May be empty. |
| Topic | Text | Topic of the stage. Maximum length: 120 characters. |
| Privacy | Stage privacy | Privacy level of the stage. |
| Discovery disabled | Yes/No | Whether the stage is hidden from discovery. May be empty. |
Server emoji
A custom emoji on your server.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Emoji ID. |
| Name | Text | Emoji name. |
| Animated | Yes/No | Whether the emoji is animated. |
| Managed | Yes/No | Whether the emoji is managed by an integration. |
| Available | Yes/No | Whether the emoji can currently be used. May be empty. |
| URL | URL | URL of the emoji image. |
| Author | User | User that uploaded the emoji. May be empty. |
| Allowed roles | List of Role | Roles that may use the emoji (empty = everyone). |
| Created at | Date and time | When the emoji was uploaded. |
Server sticker
A custom sticker on your server.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Sticker ID. |
| Name | Text | Sticker name. Maximum length: 30 characters. |
| Description | Text | Sticker description. Maximum length: 100 characters. May be empty. |
| Tags | Text | Comma-separated keyword list used by autocomplete. May be empty. |
| Available | Yes/No | Whether the sticker can currently be used. May be empty. |
| URL | URL | URL of the sticker image. |
Invite
An invite link to your server.
| Property | Type | Details |
|---|---|---|
| Code | Text | Invite code. |
| URL | URL | Full invite URL. |
| Channel | Server channel | Channel the invite leads to. May be empty. |
| Server | Server | The server the invite points to, or empty when unknown. May be empty. |
| Inviter | User | User that created the invite. May be empty. |
| Uses | Whole number | How many times the invite has been used. May be empty. |
| Max uses | Whole number | Maximum allowed uses (0 = unlimited). May be empty. |
| Max age | Duration | How long the invite is valid for. May be empty. |
| Temporary | Yes/No | Whether members are kicked when they leave voice if they have no role. May be empty. |
| Expires at | Date and time | When the invite expires. May be empty. |
| Created at | Date and time | When the invite was created. May be empty. |
Webhook
A Discord webhook attached to a channel.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Webhook ID. |
| Name | Text | Default name shown for messages. |
| Channel | Text channel | Channel the webhook posts to. May be empty. |
| Server | Server | Server the webhook belongs to. May be empty. |
| Owner | User | User that created the webhook. May be empty. |
| Avatar URL | URL | Default avatar shown for messages. May be empty. |
Ban
A ban on your server.
| Property | Type | Details |
|---|---|---|
| User | User | Banned user. |
| Server | Server | Server the ban applies to. |
| Reason | Text | Reason for the ban. May be empty. |
Audit log entry
A single entry from the server's audit log.
Example: Alex banned Sam.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Audit log entry ID. |
| Action | Audit log event | What happened. Example: Member banned. |
| Executor | User | Who performed the action. May be empty. Example: Alex (@alex). |
| Target ID | Discord ID | ID of the affected object. May be empty. |
| Reason | Text | Reason given for the action. May be empty. Example: Spamming links. |
| Created at | Date and time | When the entry was logged. |
| Target Type | Text | The type of object that was targeted by this audit-log entry (e.g. user, channel, role). |
| Changes | List of Audit log change | A list of individual field changes recorded in this audit-log entry. |
| Extra Data | Lookup table of Text to Text | Additional metadata associated with this audit-log entry, encoded as text key and value pairs. |
| Details | Audit log details | Typed extra data of this entry; which fields it has depends on the action. Empty when the action has none or Discord does not say who or what the entry is about, and then a Switch on kind on it runs no branch, not even Other kinds. May be empty. |
Prune details
Details of a member prune.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Members removed | Whole number | How many members were removed. |
| Inactive days | Whole number | How many days of inactivity counted. |
Channel and count details
Details of a member move or a message deletion.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Channel ID | Discord ID | The channel the action happened in. May be empty. |
| Count | Whole number | How many members or messages were affected. |
Count details
Details of a bulk message deletion or a voice disconnect.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Count | Whole number | How many messages or members were affected. Example: 12. |
Pin details
Details of pinning or unpinning a message.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Channel ID | Discord ID | The channel of the message. May be empty. |
| Message ID | Discord ID | The pinned or unpinned message. |
Permission overwrite details
Details of a channel permission overwrite change.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Target ID | Discord ID | The role or member the overwrite is for. |
| Target kind | Text | ROLE or MEMBER. |
| Role name | Text | The role's name when the overwrite is for a role. May be empty. Example: Moderators. |
Stage details
Details of a stage instance change.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Channel ID | Discord ID | The stage channel. May be empty. |
Command permission details
Details of an application command permission change.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Application ID | Discord ID | The application whose command permissions changed. |
AutoMod details
Details of an AutoMod action.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Rule name | Text | The AutoMod rule that acted. |
| Rule trigger type | Whole number | The rule's trigger type as Discord numbers it. May be empty. |
| Channel ID | Discord ID | The channel the action happened in. May be empty. |
Integration details
Details of a kick or role change made by an integration.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Integration type | Text | The type of integration that made the change. |
Ban details
Details of a ban or an unban.
Example: Sam was banned.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| User ID | Discord ID | The ID of the user who was banned or unbanned. Example: 456789012345678901. |
| Username | Text | The user's name. Empty when the bot does not know the user. May be empty. Example: sam. |
Kick details
Details of a kick.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| User ID | Discord ID | The ID of the user who was kicked. |
| Username | Text | The user's name. Empty when the bot does not know the user. May be empty. |
| Integration type | Text | The type of integration that kicked the user. Empty when a person did it. May be empty. |
Role change details
Details of roles added to or removed from a member.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| User ID | Discord ID | The ID of the member whose roles changed. |
| Username | Text | The member's name. Empty when the bot does not know the user. May be empty. |
| Added role IDs | List of Discord ID | The IDs of the roles that were added. |
| Added role names | List of Text | The names of the roles that were added, in the same order. |
| Removed role IDs | List of Discord ID | The IDs of the roles that were removed. |
| Removed role names | List of Text | The names of the roles that were removed, in the same order. |
| Integration type | Text | The type of integration that changed the roles. Empty when a person did it. May be empty. |
Member update details
Details of a change to a member, such as a new nickname or a timeout.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| User ID | Discord ID | The ID of the member who was changed. |
| Nickname before | Text | The nickname before the change. Empty when it did not change or there was none. May be empty. |
| Nickname after | Text | The nickname after the change. Empty when it did not change or was removed. May be empty. |
| Timed out until | Date and time | When the member's timeout ends. Empty when this change did not set a timeout, or removed it. May be empty. |
Role details
Details of a role that was created, changed or deleted.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Role ID | Discord ID | The ID of the role. |
| Role name | Text | The role's name. Empty when the name did not change and the bot does not know the role. May be empty. |
Channel details
Details of a channel that was created, changed or deleted.
| Property | Type | Details |
|---|---|---|
| Action | Audit log event | The audit log action these details belong to. |
| Channel ID | Discord ID | The ID of the channel. |
| Channel name | Text | The channel's name. Empty when the name did not change and the bot does not know the channel. May be empty. |
Scheduled event
A scheduled event on your server.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Event ID. |
| Name | Text | Event name. Maximum length: 100 characters. |
| Description | Text | Event description. Maximum length: 1000 characters. May be empty. |
| Channel | Voice channel | Voice or stage channel the event happens in. May be empty. |
| Creator | User | User that created the event. May be empty. |
| Location type | Event location type | Where the event takes place. |
| Privacy | Event privacy | Who can see the event. |
| Status | Event status | Current status of the event. |
| Starts at | Date and time | Scheduled start time. May be empty. |
| Ends at | Date and time | Scheduled end time. May be empty. |
| Image URL | URL | Cover image of the event. May be empty. |
| Interested users | Whole number | How many users are interested in the event. May be empty. |
| URL | URL | Direct URL to the event. |
AutoMod rule
An AutoMod rule on your server.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Rule ID. |
| Name | Text | Rule name. |
| Creator | User | User that created the rule. May be empty. |
| Event | AutoMod event | Which event the rule listens to. |
| Trigger | AutoMod trigger | How the rule decides to fire. |
| Enabled | Yes/No | Whether the rule is currently active. |
| Exempt roles | List of Role | Roles that bypass the rule. |
| Exempt channels | List of Server channel | Channels where the rule is not enforced. |
Poll answer
One answer option of a message poll.
| Property | Type | Details |
|---|---|---|
| ID | Whole number | Answer ID. |
| Text | Text | Answer text (max 55 characters). Maximum length: 55 characters. May be empty. |
| Emoji | Text | Optional emoji shown next to the answer. May be empty. |
| Vote count | Whole number | Number of votes this answer has received. |
Poll
A poll attached to a message.
| Property | Type | Details |
|---|---|---|
| Question | Text | Poll question (max 300 characters). Maximum length: 300 characters. |
| Answers | List of Poll answer | Available answer options. Items: 1 to 10. |
| Expires at | Date and time | When voting ends. May be empty. |
| Multi-select | Yes/No | Whether voters can pick more than one answer. |
| Results final | Yes/No | Whether the poll has ended and results are final. |
| Total votes | Whole number | Total number of votes across all answers. |
Reaction
A reaction on a message (emoji, reaction count and whether the bot reacted). Use it to keep reaction lists apart from other lists; its individual values cannot be read yet.
Interaction
A Discord interaction (slash command, button click, etc.).
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Interaction ID. |
| User | User | User that triggered the interaction. Example: Alex (@alex). |
| Member | Server member | User as a server member, when applicable. May be empty. |
| Server | Server | Server the interaction came from. May be empty. |
| Channel | Server channel | Channel the interaction came from. May be empty. |
| User locale | Text | Discord locale of the user. |
| Server locale | Text | Preferred locale of the server. May be empty. |
| Bot permissions | List of Permission | The permissions the bot has in the channel of this interaction. May be empty. |
| Created at | Date and time | When the interaction was created. |
Button click
An interaction caused by clicking a message button.
Builds on: Interaction.
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Custom ID of the clicked button. |
| Message | Message | Message the button was attached to. |
| Button label | Text | Label of the clicked button. May be empty. |
| State | Text | State text the clicked button carried (the custom id set on a flow-linked button), if any. May be empty. |
Dropdown interaction
An interaction caused by submitting a dropdown.
Builds on: Interaction.
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Custom ID of the dropdown component. |
| Message | Message | Message the menu was attached to. |
| State | Text | State text the menu carried (the custom id set on a flow-linked menu), if any. May be empty. |
| Selected values | List of Text | Values the user selected. |
Modal submit
An interaction caused by submitting a modal form.
Builds on: Interaction.
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Custom ID of the submitted modal. |
| Fields | Lookup table of Text to Any | Lookup table of field custom ID to that field's answer. The value matches the field type: text, a list for dropdowns and checkbox groups, true or false for a single checkbox, and the selected items for user, role, channel or file fields. Use "Get modal field" to read one out. |
Slash command
An interaction caused by running a slash command.
Builds on: Interaction.
| Property | Type | Details |
|---|---|---|
| Command name | Text | Name of the command that was run. |
| Subcommand | Text | Name of the invoked subcommand, or empty when none was used. May be empty. |
| Subcommand group | Text | Name of the invoked subcommand group, or empty when none was used. May be empty. |
| Options | Lookup table of Text to Text | Lookup table of option ID to value (as text). |
Flow
A reference to another custom command flow.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Flow ID. |
| Name | Text | Display name of the flow. |
Default reaction
Default emoji used for reactions on posts in a forum or media channel.
| Property | Type | Details |
|---|---|---|
| Emoji ID | Discord ID | ID of a custom server emoji to use as the default reaction. May be empty. |
| Emoji Name | Text | Unicode emoji character or the name of a custom emoji. Maximum length: 64 characters. May be empty. |
Permission overwrite
A permission overwrite that grants or revokes specific permissions for a role or member on a single channel.
| Property | Type | Details |
|---|---|---|
| Target ID | Discord ID | ID of the role or member this overwrite applies to. |
| Target Type | Overwrite target type | Whether the target is a role or a member. |
| Allowed Permissions | List of Permission | Permissions explicitly granted to the target on this channel. |
| Denied Permissions | List of Permission | Permissions explicitly revoked from the target on this channel. |
Poll answer
A single answer choice for a poll, with optional emoji.
| Property | Type | Details |
|---|---|---|
| Text | Text | The answer text shown to voters (max 55 characters). Length: 1 to 55 characters. |
| Emoji | Text | Optional emoji displayed next to the answer text. May be empty. |
Server preview
A read-only preview of a discoverable server, including emojis, stickers, features, and approximate member counts.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | The server's Discord ID. |
| Name | Text | The server's display name. |
| Icon URL | URL | The server icon URL, if set. May be empty. |
| Splash URL | URL | The invite splash URL, if set. May be empty. |
| Discovery splash URL | URL | The discovery splash URL shown in the discovery directory, if set. May be empty. |
| Emojis | List of Server emoji | All custom emojis available in the server. |
| Stickers | List of Server sticker | All custom stickers available in the server. |
| Features | List of Text | Identifiers of features the server has enabled. |
| Approximate member count | Whole number | An approximate count of members in the server. |
| Approximate presence count | Whole number | An approximate count of online members in the server. |
| Description | Text | The discovery description shown for the server. May be empty. |
Server template
A snapshot of a server's structure (channels, roles, settings) that can be used to create new servers.
| Property | Type | Details |
|---|---|---|
| Code | Text | The unique template code used in invite-style URLs. |
| Name | Text | The display name of the template. |
| Description | Text | The user-provided description of the template. May be empty. |
| Usage count | Whole number | How many times this template has been used. |
| Creator | User | The user who created the template. |
| Created at | Date and time | When the template was first created. |
| Updated at | Date and time | When the template was last synced with its source server. |
| Source server | Server | The server this template was created from. May be empty. |
| Serialized source server | Text | The serialized JSON snapshot of the source server's structure. May be empty. |
| Is dirty | Yes/No | Whether the template has changes that have not been synced from the source server. May be empty. |
Server integration
An integration installed in a server, such as a Twitch sub link, YouTube creator link, or bot application.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | The integration's Discord ID. |
| Name | Text | The integration's display name. |
| Type | Text | The kind of integration (e.g. twitch, youtube, discord). |
| Enabled | Yes/No | Whether the integration is currently enabled. May be empty. |
| Account ID | Text | The external account ID linked through this integration. May be empty. |
| Account name | Text | The external account display name. May be empty. |
| Syncing | Yes/No | Whether the integration is currently being synced. May be empty. |
| Subscriber role | Role | The role granted to subscribers, if applicable. May be empty. |
| Expire behavior | Whole number | What happens when subscriber benefits expire (0 = remove role, 1 = kick member). May be empty. |
| Expire grace period | Whole number | Days to wait before applying the expire behavior. May be empty. |
| User | User | The user that added the integration. May be empty. |
| Synced at | Date and time | When the integration was last synced. May be empty. |
| Subscriber count | Whole number | Number of subscribers linked to this integration. May be empty. |
| Revoked | Yes/No | Whether the integration has been revoked. May be empty. |
| Application ID | Discord ID | The Discord application ID, for bot integrations. May be empty. |
Soundboard sound
A custom soundboard sound that can be played in voice channels.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | The sound's Discord ID. |
| Name | Text | The sound's display name. |
| Volume | Decimal number | Playback volume between 0.0 and 1.0. |
| Emoji ID | Discord ID | The custom emoji ID associated with the sound, if any. May be empty. |
| Emoji name | Text | The unicode emoji or custom emoji name shown next to the sound. May be empty. |
| Server ID | Discord ID | The server this sound belongs to (empty for default sounds). May be empty. |
| Available | Yes/No | Whether the sound is currently usable in the server. |
| User | User | The user who uploaded the sound. May be empty. |
| Created at | Date and time | When the sound was uploaded. |
AutoMod action
An action AutoMod performs when a rule is triggered.
| Property | Type | Details |
|---|---|---|
| Type | AutoMod action type | The kind of action to take. |
| Custom message | Text | Custom explanation shown to the user when their message is blocked (BLOCK_MESSAGE only). Maximum length: 150 characters. |
| Alert channel | Text channel | The channel to send alert messages to (SEND_ALERT_MESSAGE only). May be empty. |
| Timeout duration | Duration | How long to time the member out (TIMEOUT only). May be empty. |
AutoMod trigger metadata
Configuration values for an AutoMod rule's trigger, varying by trigger type.
| Property | Type | Details |
|---|---|---|
| Keyword filter | List of Text | Pieces of text or wildcard patterns that trigger the rule. |
| Regex patterns | List of Text | Rust-flavored regex patterns that trigger the rule. |
| Keyword presets | List of AutoMod keyword preset | Discord-curated keyword preset lists to enable. |
| Allow list | List of Text | Pieces of text exempted from filtering. |
| Mention total limit | Whole number | The maximum number of unique role and user mentions allowed in a single message. Value: 1 to 50. May be empty. |
| Mention raid protection | Yes/No | Whether to use Discord's mention raid protection heuristics. |
Command option choice
A predefined choice for a slash command option.
| Property | Type | Details |
|---|---|---|
| Name | Text | The label shown to users (max 100 chars). Length: 1 to 100 characters. |
| Value | Text | The value sent to your bot when this choice is selected. Length: 1 to 100 characters. |
Command option
A single option (parameter) of a slash command.
| Property | Type | Details |
|---|---|---|
| Name | Text | Internal name of the option (lowercase, 1-32 chars). Length: 1 to 32 characters. Must match ^[-_a-z0-9]+$. |
| Description | Text | User-facing description (1-100 chars). Length: 1 to 100 characters. |
| Type | Slash command option type | The data type accepted by this option. |
| Required | Yes/No | Whether the user must provide this option. Default: No. |
| Choices | List of Command option choice | Predefined choices the user can pick from (max 25). Maximum items: 25. |
| Channel types | List of Channel type | Restricts channel options to specific channel types. |
| Min value | Decimal number | Minimum allowed numeric value. May be empty. |
| Max value | Decimal number | Maximum allowed numeric value. May be empty. |
| Min length | Whole number | Minimum allowed text length. Value: 0 to 6000. May be empty. |
| Max length | Whole number | Maximum allowed text length. Value: 1 to 6000. May be empty. |
| Autocomplete | Yes/No | Enables dynamic autocomplete suggestions for this option. Default: No. May be empty. |
| Static suggestions | List of Text | Suggestions offered automatically as the user types - no flow required (max 100, requires autocomplete). Maximum items: 100. |
| Subcommands / nested options | List of Command option | Nested options for subcommands and subcommand groups (max 25). Maximum items: 25. |
Application command
A registered slash, user, or message command on Discord.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Discord ID of the command. |
| Application ID | Discord ID | ID of the application that owns this command. |
| Type | Application command type | The kind of application command. |
| Server ID | Discord ID | ID of the server this command is registered in (if any). May be empty. |
| Name | Text | Name of the command (1-32 chars). Length: 1 to 32 characters. |
| Description | Text | Description of the command (max 100 chars). Maximum length: 100 characters. |
| Options | List of Command option | The options/parameters of this command. Maximum items: 25. |
| Default permissions | List of Permission | Required member permissions to use this command by default. |
| DM permission | Yes/No | Whether the command is usable in DMs. Default: Yes. May be empty. |
| NSFW | Yes/No | Whether the command is age-restricted. Default: No. |
| Version | Discord ID | Auto-incrementing version ID of the command. |
Text input
A text input field used inside a modal.
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Identifier sent back when the modal is submitted (max 100 chars). Length: 1 to 100 characters. |
| Label | Text | Label shown above the field (max 45 chars). Length: 1 to 45 characters. |
| Style | Text input style | Whether the input is a single line or paragraph. |
| Min length | Whole number | Minimum allowed input length (0-4000). Value: 0 to 4000. May be empty. |
| Max length | Whole number | Maximum allowed input length (1-4000). Value: 1 to 4000. May be empty. |
| Required | Yes/No | Whether the user must fill this field. Default: Yes. May be empty. |
| Default value | Text | Pre-filled value of the field (max 4000 chars). Maximum length: 4000 characters. May be empty. |
| Placeholder | Text | Hint text shown when the field is empty (max 100 chars). Maximum length: 100 characters. May be empty. |
Modal
A pop-up form with text inputs that the user can submit.
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Identifier sent back when the modal is submitted (max 100 chars). Length: 1 to 100 characters. |
| Title | Text | Title shown at the top of the modal (max 45 chars). Length: 1 to 45 characters. |
| Components | List of Form field | The text inputs in the modal (1-5 items). Items: 1 to 5. |
Select option
A single option in a dropdown.
| Property | Type | Details |
|---|---|---|
| Label | Text | Label shown to the user (max 100 chars). Length: 1 to 100 characters. |
| Value | Text | Value sent back when this option is chosen (max 100 chars). Length: 1 to 100 characters. |
| Description | Text | Optional description shown below the label. Maximum length: 100 characters. May be empty. |
| Emoji | Text | Optional emoji displayed next to the label. May be empty. |
| Default | Yes/No | Whether this option is selected by default. Default: No. May be empty. |
| Flow to run | Flow | The flow that runs when someone picks this option. Leave blank to use the menu's own flow. May be empty. |
Form field option
One choice in a dropdown, checkbox group or radio group of a pop-up form (modal).
| Property | Type | Details |
|---|---|---|
| Label | Text | Text the member sees for this choice (max 100 chars). Length: 1 to 100 characters. |
| Value | Text | Value reported back when this choice is picked (max 100 chars). Length: 1 to 100 characters. |
| Description | Text | Extra line shown under the label (max 100 chars). Maximum length: 100 characters. May be empty. |
| Selected by default | Yes/No | Whether this choice is already picked when the modal opens. Default: No. May be empty. |
Form field
A single field of a pop-up form (modal). Which settings apply depends on the field type.
| Property | Type | Details |
|---|---|---|
| Field type | Form field type | The kind of field to show. Leave empty for a text input. May be empty. |
| Custom ID | Text | Identifier this field's answer is read back under (max 100 chars). Not needed for a text block. Length: 1 to 100 characters. May be empty. |
| Label | Text | Label shown above the field (max 45 chars). Length: 1 to 45 characters. May be empty. |
| Description | Text | Helper text shown under the label (max 100 chars). Maximum length: 100 characters. May be empty. |
| Required | Yes/No | Whether the member must answer this field before submitting. Default: Yes. May be empty. |
| Placeholder | Text | Greyed-out hint shown while the field is empty (max 150 chars). Maximum length: 150 characters. May be empty. |
| Style | Text input style | Whether a text input is a single line or a multi-line box. May be empty. |
| Minimum length | Whole number | Fewest characters a text input accepts. Value: 0 to 4000. May be empty. |
| Maximum length | Whole number | Most characters a text input accepts. Value: 1 to 4000. May be empty. |
| Prefilled value | Text | Text the field already contains when the modal opens (max 4000 chars). Maximum length: 4000 characters. May be empty. |
| Options | List of Form field option | The choices a dropdown, checkbox group or radio group offers (max 25 items). Maximum items: 25. |
| Minimum selections | Whole number | Fewest options the member must pick. Value: 0 to 25. May be empty. |
| Maximum selections | Whole number | Most options the member may pick. Value: 1 to 25. May be empty. |
| Channel types | List of Channel type | Restricts a channel picker to these kinds of channel. Empty allows all. |
| Minimum files | Whole number | Fewest files the member must upload. Value: 1 to 10. May be empty. |
| Maximum files | Whole number | Most files the member may upload. Value: 1 to 10. May be empty. |
| Checked by default | Yes/No | Whether a single checkbox starts out checked. Default: No. May be empty. |
| Text | Text | The text a display-only block shows (max 4000 chars). Not an input the member fills in. Maximum length: 4000 characters. May be empty. |
Dropdown
A dropdown component (text choices, user, role, channel or user-or-role).
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Identifier sent back when an option is chosen (max 100 chars). Length: 1 to 100 characters. |
| Type | Dropdown type | The kind of dropdown. Default: Dropdown. |
| Placeholder | Text | Hint text shown when nothing is selected. Maximum length: 150 characters. May be empty. |
| Min values | Whole number | Minimum number of items the user must select (0-25). Value: 0 to 25. Default: 1. May be empty. |
| Max values | Whole number | Maximum number of items the user can select (1-25). Value: 1 to 25. Default: 1. May be empty. |
| Disabled | Yes/No | Whether the menu is disabled. Default: No. May be empty. |
| Options | List of Select option | The options for a dropdown (max 25). Maximum items: 25. |
| Channel types | List of Channel type | Restricts a channel select to specific channel types. |
| Target flow | Flow | Optional flow to invoke when this menu is used. May be empty. |
Entitlement
A user or server's access to a premium SKU offered by an application.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | Unique ID of the entitlement. |
| SKU ID | Discord ID | ID of the SKU this entitlement grants access to. |
| Application ID | Discord ID | ID of the application that owns the SKU. |
| User ID | Discord ID | ID of the user this entitlement was granted to, if any. |
| Server ID | Discord ID | ID of the server this entitlement was granted to, if any. May be empty. |
| Type | Entitlement type | Type of entitlement. |
| Deleted | Yes/No | Whether this entitlement has been deleted. |
| Starts At | Date and time | When the entitlement period started, if applicable. May be empty. |
| Ends At | Date and time | When the entitlement period ends, if applicable. May be empty. |
Activity
A single activity entry from a user's presence (game, listening, custom status, etc.).
| Property | Type | Details |
|---|---|---|
| Name | Text | Name of the activity (e.g. game title, song title). |
| Type | Activity type | What kind of activity this is (Playing, Streaming, Listening, ...). |
| URL | URL | Stream URL, only present for streaming activities. May be empty. |
| Details | Text | What the user is currently doing inside the activity. May be empty. |
| State | Text | User-defined state, e.g. the text of a custom status. May be empty. |
| Application ID | Discord ID | ID of the application this activity belongs to, if any. May be empty. |
| Created At | Date and time | Timestamp when this activity started. |
Presence
A user's presence in a server: online status, activities and per-client status.
| Property | Type | Details |
|---|---|---|
| User ID | Discord ID | ID of the user this presence belongs to. |
| Server ID | Discord ID | ID of the server this presence is from. May be empty. |
| Status | Presence status | Overall online status (online, idle, dnd, offline, invisible). |
| Activities | List of Activity | List of activities the user currently has. |
| Desktop Status | Presence status | Status on the desktop client, if connected. May be empty. |
| Mobile Status | Presence status | Status on the mobile client, if connected. May be empty. |
| Web Status | Presence status | Status on the web client, if connected. May be empty. |
User dropdown interaction
An interaction created when a user submits a user dropdown.
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Custom ID of the dropdown component. |
| Message | Message | Message the menu was attached to. |
| State | Text | State text the menu carried (the custom id set on a flow-linked menu), if any. May be empty. |
| Selected Users | List of User | Users that were selected. |
| Selected Members | List of Server member | Server members corresponding to the selected users, when available. |
Role dropdown interaction
An interaction created when a user submits a role dropdown.
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Custom ID of the dropdown component. |
| Message | Message | Message the menu was attached to. |
| State | Text | State text the menu carried (the custom id set on a flow-linked menu), if any. May be empty. |
| Selected Roles | List of Role | Roles that were selected. |
Channel dropdown interaction
An interaction created when a user submits a channel dropdown.
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Custom ID of the dropdown component. |
| Message | Message | Message the menu was attached to. |
| State | Text | State text the menu carried (the custom id set on a flow-linked menu), if any. May be empty. |
| Selected Channels | List of Server channel | Channels that were selected. |
User-or-role dropdown interaction
An interaction created when a user submits a user-or-role dropdown (users and roles).
| Property | Type | Details |
|---|---|---|
| Custom ID | Text | Custom ID of the dropdown component. |
| Message | Message | Message the menu was attached to. |
| State | Text | State text the menu carried (the custom id set on a flow-linked menu), if any. May be empty. |
| Selected Users | List of User | Users selected in the menu. |
| Selected Roles | List of Role | Roles selected in the menu. |
User context menu interaction
An interaction created when a user runs a user context-menu command.
| Property | Type | Details |
|---|---|---|
| Command Name | Text | Name of the context-menu command that was used. |
| Target User | User | User the command was used on. |
| Target Member | Server member | Server member representation of the target user, when used in a server. May be empty. |
Message context menu interaction
An interaction created when a user runs a message context-menu command.
| Property | Type | Details |
|---|---|---|
| Command Name | Text | Name of the context-menu command that was used. |
| Target Message | Message | Message the command was used on. |
Autocomplete interaction
An interaction representing an autocomplete request for a slash-command option.
| Property | Type | Details |
|---|---|---|
| Command Name | Text | Name of the slash command that triggered autocomplete. |
| Focused Option Name | Text | Name of the option the user is currently typing in. May be empty. |
| Focused Option Value | Text | Current partial value the user has typed. May be empty. |
| Subcommand | Text | Name of the subcommand the user is typing in, or empty when the command has none. May be empty. |
| Subcommand Group | Text | Name of the subcommand group the user is typing in, or empty when none is used. May be empty. |
Flow parameter
Declares one typed parameter (or return value) of a flow. The id is the public identity callers pass arguments to; the type controls what values are accepted.
| Property | Type | Details |
|---|---|---|
| ID | Text | Stable id (kebab-case, lowercase letters/digits/dashes). Callers pass arguments under this id; inside the flow you read it by this id. Length: 1 to 32 characters. Must match ^[a-z0-9-]+$. |
| Type | Flow parameter type | Type of the value. Callers must pass a compatible value. |
| Content type | Type | For a list or lookup table: the type of each item. Lists and lookup tables may be nested. |
| Optional | Yes/No | Whether callers may omit this parameter. Default: No. May be empty. |
| Description | Text | Hint shown to callers about what to pass. Maximum length: 200 characters. May be empty. |
Media item
A reference to an image, video, or file used by Components V2 media containers.
| Property | Type | Details |
|---|---|---|
| URL | URL | The source URL of the media. May reference an attachment via attachment://filename. |
| Height | Whole number | Pixel height of the media (filled by Discord on responses). May be empty. |
| Width | Whole number | Pixel width of the media (filled by Discord on responses). May be empty. |
| Content Type | Text | MIME type of the media (filled by Discord on responses). May be empty. |
| Attachment ID | Discord ID | Discord ID of the attached file, if backed by an upload. May be empty. |
| Proxy URL | URL | Discord's proxied URL for the media (filled on responses). May be empty. |
Media gallery item
A single image or video entry inside a media gallery component.
| Property | Type | Details |
|---|---|---|
| Media | Media item | The underlying media item (URL or attachment reference). |
| Description | Text | Alt text for accessibility (max 1024 characters). Maximum length: 1024 characters. May be empty. |
| Spoiler | Yes/No | Whether the item should be marked as a spoiler. Default: No. |
Thumbnail component
A small media accessory shown next to a section's text content.
| Property | Type | Details |
|---|---|---|
| Media | Media item | The image or video shown as the thumbnail. |
| Description | Text | Alt text for accessibility (max 1024 characters). Maximum length: 1024 characters. May be empty. |
| Spoiler | Yes/No | Whether the thumbnail should be marked as a spoiler. Default: No. |
File component
A Components V2 file block that displays an attached file inline.
| Property | Type | Details |
|---|---|---|
| File | Media item | The media item to display (typically an attachment:// reference). |
| Spoiler | Yes/No | Whether the file should be marked as a spoiler. Default: No. |
| Name | Text | Display name (filled by Discord on responses). May be empty. |
| Size | Whole number | File size in bytes (filled by Discord on responses). May be empty. |
Separator component
A vertical spacer with an optional divider line.
| Property | Type | Details |
|---|---|---|
| Divider | Yes/No | Whether to render a thin horizontal line. Default: Yes. |
| Spacing | Separator spacing | How much vertical space the separator takes. Default: Small. |
Text display component
A Components V2 text block supporting markdown (max 4000 characters).
| Property | Type | Details |
|---|---|---|
| Content | Text | Markdown text rendered by the client. Maximum length: 4000 characters. |
Section component
Groups one to three text-display children with an accessory (thumbnail or button).
| Property | Type | Details |
|---|---|---|
| Text Displays | List of Text display component | 1-3 text-display children rendered as the section body. Items: 1 to 3. |
| Accessory (Thumbnail) | Thumbnail component | Use a thumbnail as the section's accessory. Provide either this or a button. Use only one of these: Accessory (Button) May be empty. |
| Accessory (Button) | Button | Use a button as the section's accessory. Provide either this or a thumbnail. Use only one of these: Accessory (Thumbnail) May be empty. |
Media gallery component
A grid of 1-10 images or videos.
| Property | Type | Details |
|---|---|---|
| Items | List of Media gallery item | The gallery's media items (1-10 entries). Items: 1 to 10. |
Action row component
Holds either up to five buttons OR exactly one dropdown of any kind.
| Property | Type | Details |
|---|---|---|
| Buttons | List of Button | Up to 5 buttons. Mutually exclusive with dropdowns. Maximum items: 5. Use only one of these: Dropdown, User dropdown, Role dropdown, Channel dropdown, User-or-role dropdown. |
| Dropdown | Dropdown | A dropdown. Mutually exclusive with other contents. Use only one of these: Buttons, User dropdown, Role dropdown, Channel dropdown, User-or-role dropdown. May be empty. |
| User dropdown | User dropdown | A user dropdown. Mutually exclusive with other contents. Use only one of these: Buttons, Dropdown, Role dropdown, Channel dropdown, User-or-role dropdown. May be empty. |
| Role dropdown | Role dropdown | A role dropdown. Mutually exclusive with other contents. Use only one of these: Buttons, Dropdown, User dropdown, Channel dropdown, User-or-role dropdown. May be empty. |
| Channel dropdown | Channel dropdown | A channel dropdown. Mutually exclusive with other contents. Use only one of these: Buttons, Dropdown, User dropdown, Role dropdown, User-or-role dropdown. May be empty. |
| User-or-role dropdown | User-or-role dropdown | A user-or-role dropdown. Mutually exclusive with other contents. Use only one of these: Buttons, Dropdown, User dropdown, Role dropdown, Channel dropdown. May be empty. |
Container component
A Components V2 container that groups other components with an accent stripe and optional spoiler. Each kind of component has its own field.
| Property | Type | Details |
|---|---|---|
| Accent Color | Color | Color shown as the container's left edge. May be empty. |
| Spoiler | Yes/No | Whether the entire container is hidden behind a spoiler. Default: No. |
| Text Displays | List of Text display component | Text-display children placed in the container. Default: []. |
| Sections | List of Section component | Section children placed in the container. Default: []. |
| Media Galleries | List of Media gallery component | Media gallery children placed in the container. Default: []. |
| Separators | List of Separator component | Separator children placed in the container. Default: []. |
| Files | List of File component | File children placed in the container. Default: []. |
| Action Rows | List of Action row component | Action row children placed in the container. Default: []. |
User dropdown
A dropdown auto-populated with users from the server.
| Property | Type | Details |
|---|---|---|
| Target Flow | Flow | Flow to invoke when a selection is made. May be empty. |
| Placeholder | Text | Placeholder text shown when nothing is selected (max 150). Maximum length: 150 characters. May be empty. |
| Min Values | Whole number | Minimum number of selectable users (0-25). Value: 0 to 25. Default: 1. |
| Max Values | Whole number | Maximum number of selectable users (1-25). Value: 1 to 25. Default: 1. |
| Disabled | Yes/No | Whether the menu is rendered as disabled. Default: No. |
| Default Users | List of User | Up to 25 users pre-selected when the menu first appears. Maximum items: 25. |
Role dropdown
A dropdown auto-populated with roles from the server.
| Property | Type | Details |
|---|---|---|
| Target Flow | Flow | Flow to invoke when a selection is made. May be empty. |
| Placeholder | Text | Placeholder text shown when nothing is selected (max 150). Maximum length: 150 characters. May be empty. |
| Min Values | Whole number | Minimum number of selectable roles (0-25). Value: 0 to 25. Default: 1. |
| Max Values | Whole number | Maximum number of selectable roles (1-25). Value: 1 to 25. Default: 1. |
| Disabled | Yes/No | Whether the menu is rendered as disabled. Default: No. |
| Default Roles | List of Role | Up to 25 roles pre-selected when the menu first appears. Maximum items: 25. |
Channel dropdown
A dropdown auto-populated with channels from the server.
| Property | Type | Details |
|---|---|---|
| Target Flow | Flow | Flow to invoke when a selection is made. May be empty. |
| Placeholder | Text | Placeholder text shown when nothing is selected (max 150). Maximum length: 150 characters. May be empty. |
| Min Values | Whole number | Minimum number of selectable channels (0-25). Value: 0 to 25. Default: 1. |
| Max Values | Whole number | Maximum number of selectable channels (1-25). Value: 1 to 25. Default: 1. |
| Disabled | Yes/No | Whether the menu is rendered as disabled. Default: No. |
| Default Channels | List of Server channel | Up to 25 channels pre-selected when the menu first appears. Maximum items: 25. |
| Channel Types | List of Channel type | Restrict selectable channels to these types. |
User-or-role dropdown
A dropdown auto-populated with both users and roles.
| Property | Type | Details |
|---|---|---|
| Target Flow | Flow | Flow to invoke when a selection is made. May be empty. |
| Placeholder | Text | Placeholder text shown when nothing is selected (max 150). Maximum length: 150 characters. May be empty. |
| Min Values | Whole number | Minimum number of selectable users or roles (0-25). Value: 0 to 25. Default: 1. |
| Max Values | Whole number | Maximum number of selectable users or roles (1-25). Value: 1 to 25. Default: 1. |
| Disabled | Yes/No | Whether the menu is rendered as disabled. Default: No. |
| Default Users | List of User | Up to 25 users pre-selected when the menu first appears. Maximum items: 25. |
| Default Roles | List of Role | Up to 25 roles pre-selected when the menu first appears. Maximum items: 25. |
Application install parameters
OAuth2 install parameters used by Discord's in-app authorization link for the application.
| Property | Type | Details |
|---|---|---|
| Scopes | List of Text | OAuth2 scopes requested when installing the application. |
| Permissions | List of Permission | Permissions requested for the bot when installed. |
Application
The Discord application this bot belongs to, including all public metadata.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | The unique Discord ID of the application. |
| Name | Text | The display name of the application. |
| Icon URL | URL | The URL to the application's icon image. May be empty. |
| Description | Text | The description shown on the application's profile. |
| RPC Origins | List of Text | List of allowed RPC origin URLs. |
| Bot Public | Yes/No | Whether the bot can be added by anyone or only the owner. May be empty. |
| Bot Requires Code Grant | Yes/No | Whether the bot requires the OAuth2 code grant flow to be added. May be empty. |
| Terms of Service URL | URL | The URL of the application's terms of service. May be empty. |
| Privacy Policy URL | URL | The URL of the application's privacy policy. May be empty. |
| Owner | User | The user who owns the application, if individually owned. May be empty. |
| Verify Key | Text | Hex-encoded key for verification in interactions and the GameSDK. |
| Team Name | Text | Name of the team that owns the application, if any. May be empty. |
| Server ID | Discord ID | Server associated with the application (e.g. support server). May be empty. |
| Primary SKU ID | Discord ID | The ID of the primary SKU of a game sold on Discord, if any. May be empty. |
| Slug | Text | URL slug used by the application's store page. May be empty. |
| Cover Image URL | URL | The URL of the application's default rich-presence cover image. May be empty. |
| Flags | List of Application flag | Public flags describing capabilities and settings of the application. |
| Approximate Server Count | Whole number | Approximate number of servers the application has been added to. May be empty. |
| Approximate User Install Count | Whole number | Approximate number of users that have installed the application. May be empty. |
| Install Parameters | Application install parameters | Default in-app authorization parameters. May be empty. |
| Custom Install URL | URL | Custom URL Discord redirects users to for installing the app. May be empty. |
| Role Connections Verification URL | URL | URL Discord opens to verify role connections. May be empty. |
| Tags | List of Text | Up to five tags describing the application. |
Role connection metadata
A single metadata field that the application exposes to Discord for use in role-connection requirements.
| Property | Type | Details |
|---|---|---|
| Type | Role connection metadata type | Comparison operator used to evaluate this field. |
| Key | Text | Internal dictionary key (a-z, 0-9, underscore, max 50 chars). Maximum length: 50 characters. Must match ^[a-z0-9_]+$. |
| Name | Text | Human-readable name shown to users (max 100 chars). Maximum length: 100 characters. |
| Description | Text | Human-readable description shown to users (max 200 chars). Maximum length: 200 characters. |
SKU
A premium offering (SKU) that users can subscribe to or purchase via Discord.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | The unique Discord ID of the SKU. |
| Type | SKU type | The category of the SKU (durable, consumable, subscription, ...). |
| Application ID | Discord ID | The ID of the parent application. |
| Name | Text | Customer-facing name of the SKU. |
| Slug | Text | URL-friendly identifier for the SKU. |
| Flags | List of Text | Flags applied to the SKU. |
Subscription
A user's subscription to one or more SKUs of this application.
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | The unique Discord ID of the subscription. |
| User ID | Discord ID | ID of the user who is subscribed. |
| SKU IDs | List of Discord ID | List of SKUs the user is currently subscribed to. |
| Entitlement IDs | List of Discord ID | List of entitlements granted by this subscription. |
| Current Period Start | Date and time | When the current billing period started. |
| Current Period End | Date and time | When the current billing period ends. |
| Status | Subscription status | The current status of the subscription. |
| Canceled At | Date and time | When the subscription was canceled, if applicable. May be empty. |
| Country | Text | ISO3166-1 alpha-2 country code of the payment source. Only present when querying as the subscribed user. May be empty. |
| Renewal SKU IDs | List of Discord ID | List of SKUs that will replace the current ones at the next renewal. |
Application emoji
A custom emoji owned by the application (not by a specific server).
| Property | Type | Details |
|---|---|---|
| ID | Discord ID | The unique Discord ID of the emoji. |
| Name | Text | The emoji's name. |
| Animated | Yes/No | Whether the emoji is animated. |
| Available | Yes/No | Whether the emoji is currently usable. |
| URL | URL | Direct URL to the emoji's image. |
| Created At | Date and time | When the emoji was created. |
| Author | User | The user that uploaded the emoji, if known. |
Audit log change
A single field change recorded as part of an audit-log entry. Old and new values are saved as text because audit-log change values come in many kinds.
| Property | Type | Details |
|---|---|---|
| Key | Text | The name of the field that changed (e.g. "name", "permissions"). |
| Old Value | Text | The previous value of the field, saved as text. May be empty if the field was newly set. May be empty. |
| New Value | Text | The new value of the field, saved as text. May be empty if the field was cleared. May be empty. |
Welcome screen channel
A single channel entry shown on a server's welcome screen, with a short description and optional emoji.
| Property | Type | Details |
|---|---|---|
| Channel | Server channel | The channel highlighted on the welcome screen. May be empty. |
| Description | Text | Short description shown next to the channel (max 50 characters). Maximum length: 50 characters. |
| Emoji ID | Discord ID | Discord ID of a custom emoji shown next to the channel, or empty when using a unicode emoji. May be empty. |
| Emoji Name | Text | Name of a custom emoji or the literal unicode emoji shown next to the channel. May be empty. |
Welcome screen
A server's welcome screen, shown to new members in Community servers. Contains an overall description and up to five highlighted channels.
| Property | Type | Details |
|---|---|---|
| Description | Text | Server description shown on the welcome screen (max 140 characters). May be empty. Maximum length: 140 characters. May be empty. |
| Welcome Channels | List of Welcome screen channel | Up to five channels highlighted on the welcome screen. Items: 0 to 5. |
Onboarding prompt option
A single selectable option within an onboarding prompt. Picking this option assigns the listed channels and roles to the new member.
| Property | Type | Details |
|---|---|---|
| Option ID | Discord ID | Discord ID of this prompt option. |
| Channel IDs | List of Discord ID | Channels granted to the member when this option is selected. |
| Role IDs | List of Discord ID | Roles granted to the member when this option is selected. |
| Emoji ID | Discord ID | Discord ID of the custom emoji on the option, or empty when using a unicode emoji. May be empty. |
| Emoji Name | Text | Custom emoji name, or the unicode emoji character. May be empty. |
| Emoji Animated | Yes/No | Whether the emoji is animated. May be empty. |
| Title | Text | Title of the option (max 50 characters). Maximum length: 50 characters. |
| Description | Text | Optional secondary line shown beneath the title (max 100 characters). Maximum length: 100 characters. May be empty. |
Onboarding prompt
A question shown to new members during onboarding. Each prompt has a list of options the member can pick from.
| Property | Type | Details |
|---|---|---|
| Prompt ID | Discord ID | Discord ID of this prompt. |
| Type | Onboarding prompt type | Whether the prompt is rendered as multiple choice or as a dropdown. |
| Options | List of Onboarding prompt option | Selectable answers (1-50). Items: 1 to 50. |
| Title | Text | Title of the prompt (max 100 characters). Maximum length: 100 characters. |
| Single Select | Yes/No | Whether only one option may be selected. |
| Required | Yes/No | Whether the user must answer this prompt before completing onboarding. |
| In Onboarding | Yes/No | Whether the prompt appears in the initial onboarding flow as opposed to only being available later. |
Server onboarding
A server's onboarding configuration: prompts, default channels, mode and enabled state.
| Property | Type | Details |
|---|---|---|
| Server ID | Discord ID | Discord ID of the server this onboarding belongs to. |
| Prompts | List of Onboarding prompt | Onboarding prompts shown to new members. |
| Default Channel IDs | List of Discord ID | Channels every member sees by default. At least seven are required. Minimum items: 7. |
| Enabled | Yes/No | Whether onboarding is currently enabled. |
| Mode | Onboarding mode | Whether to count only default channels or also prompt channels for onboarding requirements. |
Application command permission
A single allow/deny override for an application command targeting a role, user or channel.
| Property | Type | Details |
|---|---|---|
| Target ID | Discord ID | Discord ID of the role, user or channel this overwrite targets. |
| Type | Application command permission type | Whether the target is a role, user or channel. |
| Permission | Yes/No | True grants access to the command for the target, false denies it. |
Server application command permissions
All permission overwrites for a single application command in a server (up to 100 entries).
| Property | Type | Details |
|---|---|---|
| Command ID | Discord ID | Discord ID of the application command, or of the application itself for default command permissions. |
| Application ID | Discord ID | Discord ID of the application that owns the command. |
| Server ID | Discord ID | Discord ID of the server these permissions apply to. |
| Permissions | List of Application command permission | Up to 100 individual permission overwrites for this command. Maximum items: 100. |
Channel position update
An entry describing how a single channel should be repositioned during a bulk channel-position update.
| Property | Type | Details |
|---|---|---|
| Channel | Server channel | The channel being repositioned. |
| Position | Whole number | The new sort position. |
| Lock Permissions | Yes/No | When true, syncs the channel's permissions with the new parent category. May be empty. |
| Parent ID | Discord ID | Discord ID of a new parent category, or empty to move the channel out of any category. May be empty. |
Role position update
An entry describing how a single role should be repositioned during a bulk role-position update.
| Property | Type | Details |
|---|---|---|
| Role | Role | The role being repositioned. |
| Position | Whole number | The new sort position. |
Storage entry
A single entry of a storage field.
| Property | Type | Details |
|---|---|---|
| Subject | Text | User ID or key the value is stored under. |
| Value | Stored value | The stored value. |
| Rank | Whole number | Position of this entry in the sorted result, starting at 1. Example: 1. |
User storage entry
A user-scoped storage entry with its Discord user resolved for direct use.
| Property | Type | Details |
|---|---|---|
| User | User | The resolved Discord user, or empty if that user no longer exists. No separate fetch step is needed. May be empty. |
| User ID | Discord ID | The stable Discord user ID stored with this entry. |
Execution summary
A summary of one recorded flow execution.
| Property | Type | Details |
|---|---|---|
| Number | Whole number | The execution number. |
| Status | Text | How the run ended (e.g. SUCCESS, FAILED, STOPPED). |
| Timestamp | Date and time | When the run was recorded. |
| Trigger | Text | The trigger type that started the run. |
Scheduled run
A flow run that has been scheduled but has not happened yet.
| Property | Type | Details |
|---|---|---|
| Run ID | Text | Handle for this scheduled run. Pass it to "Cancel scheduled flow run". |
| Target flow | Text | The flow that will run. |
| Run at | Date and time | When the run will happen. |
Lookup table entry
A single key and value pair of a lookup table.
Example: Red team: 120.
| Property | Type | Details |
|---|---|---|
| Key | Text | The key this pair is stored under. Example: Red team. |
| Value | Stored value | The value stored under that key. Example: 120. |
top.gg vote
One vote for your project on top.gg.
| Property | Type | Details |
|---|---|---|
| User ID | Discord ID | The Discord ID of the user who voted. |
| top.gg user ID | ID | The ID of the user on top.gg. |
| Weight | Whole number | How much the vote counts: 2 for weekend votes, otherwise 1. |
| Voted at | Date and time | When the user voted. |
| Expires at | Date and time | When the vote stops counting, 12 hours after it was cast. |
top.gg vote event
Everything top.gg sent about one vote.
| Property | Type | Details |
|---|---|---|
| Vote ID | ID | The ID of this vote on top.gg. Empty for test events. May be empty. |
| User ID | Discord ID | The Discord ID of the user who voted. |
| Username | Text | The Discord username of the user who voted. May be empty. |
| Avatar URL | URL | The avatar image of the user who voted. May be empty. |
| Weight | Whole number | How much the vote counts: 2 for weekend votes, otherwise 1. Empty for test events. May be empty. |
| Voted at | Date and time | When the user voted. Empty for test events. May be empty. |
| Expires at | Date and time | When the vote stops counting. Empty for test events. May be empty. |
| Bot or server ID | Discord ID | The Discord ID of the bot or server that got the vote. |
Twitch clip
One clip of a Twitch channel.
| Property | Type | Details |
|---|---|---|
| Clip ID | ID | The ID of the clip. |
| Link | URL | The address of the clip. |
| Title | Text | The title of the clip. |
| Clipped by | Text | The name of the user who made the clip. |
| Views | Whole number | How often the clip was watched. |
| Created at | Date and time | When the clip was made. |
| Length in seconds | Decimal number | How long the clip is, in seconds. |
| Preview image | URL | The preview image of the clip. May be empty. |
Forecast day
The weather forecast for one day.
| Property | Type | Details |
|---|---|---|
| Day | Date and time | Midnight at the start of the day, in the place's time zone. |
| Weather code | Whole number | The WMO weather code: 0 clear, 1 to 3 partly cloudy to overcast, 45 and 48 fog, 51 to 67 drizzle and rain, 71 to 77 snow, 80 to 82 rain showers, 85 and 86 snow showers, 95 to 99 thunderstorm. May be empty. |
| Highest temperature | Decimal number | The highest temperature of the day. May be empty. |
| Lowest temperature | Decimal number | The lowest temperature of the day. May be empty. |
| Precipitation in mm | Decimal number | Rain, showers and snow of the day together, in millimeters. May be empty. |
| Chance of rain in % | Whole number | The highest chance of precipitation during the day, in percent. May be empty. |
| Strongest wind | Decimal number | The highest wind speed of the day, in the chosen unit. May be empty. |
| Sunrise | Date and time | When the sun rises. May be empty. |
| Sunset | Date and time | When the sun sets. May be empty. |
CoinGecko coin
One coin in the market list.
| Property | Type | Details |
|---|---|---|
| Coin ID | ID | The CoinGecko API ID, for example bitcoin. |
| Symbol | Text | The ticker symbol, for example btc. |
| Name | Text | The name of the coin. |
| Logo | URL | The logo of the coin. Empty when it has none. May be empty. |
| Price | Decimal number | The price in the chosen currency. May be empty. |
| Market cap | Decimal number | The market cap in the chosen currency. May be empty. |
| Rank | Whole number | The place by market cap. May be empty. |
| Change in 24 hours in % | Decimal number | How much the price changed in the last 24 hours, in percent. May be empty. |
Anime
One anime on MyAnimeList.
| Property | Type | Details |
|---|---|---|
| MyAnimeList ID | ID | The ID of the anime on MyAnimeList. |
| Link | URL | The MyAnimeList page. |
| Title | Text | The main title. |
| English title | Text | The English title, when there is one. May be empty. |
| Type | Text | TV, Movie, OVA, ONA, Special or Music. May be empty. |
| Status | Text | Finished Airing, Currently Airing or Not yet aired. May be empty. |
| Score | Decimal number | The average score from 1 to 10. May be empty. |
| Rank | Whole number | The place by score on MyAnimeList. May be empty. |
| Synopsis | Text | The English summary. May be empty. |
| Cover image | URL | The cover image. May be empty. |
| Episodes | Whole number | How many episodes it has, when known. May be empty. |
| Year | Whole number | The year it started airing, when known. May be empty. |
Manga
One manga on MyAnimeList.
| Property | Type | Details |
|---|---|---|
| MyAnimeList ID | ID | The ID of the manga on MyAnimeList. |
| Link | URL | The MyAnimeList page. |
| Title | Text | The main title. |
| English title | Text | The English title, when there is one. May be empty. |
| Type | Text | Manga, Novel, Light Novel, One-shot, Doujinshi, Manhwa or Manhua. May be empty. |
| Status | Text | Finished, Publishing, On Hiatus, Discontinued or Not yet published. May be empty. |
| Score | Decimal number | The average score from 1 to 10. May be empty. |
| Rank | Whole number | The place by score on MyAnimeList. May be empty. |
| Synopsis | Text | The English summary. May be empty. |
| Cover image | URL | The cover image. May be empty. |
| Chapters | Whole number | How many chapters it has, when known. May be empty. |
| Volumes | Whole number | How many volumes it has, when known. May be empty. |
GitHub issue
One issue or pull request of a repository.
| Property | Type | Details |
|---|---|---|
| Number | Whole number | The issue number, for example 1347. |
| Title | Text | The title. |
| Link | URL | The issue on GitHub. |
| State | Text | open or closed. |
| Author | Text | The username of the author. May be empty. |
| Comments | Whole number | How many comments it has. May be empty. |
| Created at | Date and time | When it was opened. |
| Pull request link | URL | The pull request on GitHub. Empty for issues, so use it to tell them apart. May be empty. |
GitHub release
One release of a repository.
| Property | Type | Details |
|---|---|---|
| Tag | Text | The tag of the release, for example v1.0.0. |
| Name | Text | The name of the release. May be empty. |
| Link | URL | The release on GitHub. |
| Release notes | Text | The release notes, as Markdown. May be empty. |
| Published at | Date and time | When it was published. Empty for drafts. May be empty. |
| Pre-release | Yes/No | Whether it is marked as a pre-release. |
| Draft | Yes/No | Whether it is a draft. |
Roblox group role
One role (rank) of a Roblox group.
| Property | Type | Details |
|---|---|---|
| Role ID | ID | The ID of the role. |
| Name | Text | The name of the role. |
| Rank | Whole number | The rank number, 0 to 255. The owner has 255. |
| Members | Whole number | How many members have the role, when the key may see it. May be empty. |
| Description | Text | The description of the role. May be empty. |
Roblox group member
One member of a Roblox group and their role.
| Property | Type | Details |
|---|---|---|
| Roblox user ID | ID | The Roblox user ID of the member. |
| Role ID | ID | The ID of the member's role. |
| Joined at | Date and time | When the member joined. May be empty. |
Roblox group membership
A group a user is in and their role there.
| Property | Type | Details |
|---|---|---|
| Group ID | ID | The ID of the group. |
| Group name | Text | The name of the group. |
| Role ID | ID | The ID of the user's role. |
| Role name | Text | The name of the user's role. |
| Rank | Whole number | The rank number of the role, 1 to 255. |
Airtable row
One row of an Airtable table.
| Property | Type | Details |
|---|---|---|
| Row ID | ID | The ID of the row, starting with rec. |
| Created at | Date and time | When the row was created. |
| Fields | Lookup table of Text to Text | The field values by field name, as text. Empty fields and list, attachment and collaborator fields are left out. |
Todoist task
One Todoist task.
| Property | Type | Details |
|---|---|---|
| Task ID | ID | The ID of the task. |
| Task | Text | The task text. |
| Description | Text | The description. May be empty. |
| Project ID | ID | The project the task is in. May be empty. |
| Priority | Whole number | 1 (normal) to 4 (urgent). Todoist shows 4 as P1. May be empty. |
| Due date | Text | The due date like 2026-10-20, or a date and time. Empty without a due date. May be empty. |
| Due text | Text | The due date as written, for example every monday. May be empty. |
| Labels | List of Text | The label names. May be empty. |
| Created at | Date and time | When the task was added. May be empty. |
Steam game
A game a Steam user owns.
| Property | Type | Details |
|---|---|---|
| App ID | ID | The Steam app ID of the game. |
| Name | Text | The name of the game. May be empty. |
| Playtime in minutes | Whole number | All playtime, in minutes. |
| Last two weeks in minutes | Whole number | Playtime in the last two weeks, in minutes. Empty when not played. May be empty. |
| Last played | Date and time | When it was last played. May be empty. |
Stripe charge
One charge.
| Property | Type | Details |
|---|---|---|
| ID | ID | The ID, starting with ch_. |
| Amount | Whole number | The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. |
| Currency | Text | The currency, for example eur. |
| Status | Text | succeeded, pending or failed. |
| Created at | Date and time | When it was created. |
| Description | Text | The description, when set. May be empty. |
| Customer ID | ID | The customer, when there is one. May be empty. |
| Paid | Yes/No | Whether the charge went through. |
| Fully refunded | Yes/No | Whether all of it was refunded. |
| Refunded amount | Whole number | The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty. |
| Text | The billing email, when given. May be empty. | |
| Receipt | URL | The receipt page. May be empty. |
Stripe payment
One payment intent.
| Property | Type | Details |
|---|---|---|
| ID | ID | The ID, starting with pi_. |
| Amount | Whole number | The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. |
| Currency | Text | The currency, for example eur. |
| Status | Text | succeeded, processing, requires_payment_method, requires_action, canceled or another step. |
| Created at | Date and time | When it was created. |
| Description | Text | The description, when set. May be empty. |
| Customer ID | ID | The customer, when there is one. May be empty. |
| Received amount | Whole number | The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty. |
Stripe checkout session
One Checkout session.
| Property | Type | Details |
|---|---|---|
| ID | ID | The ID, starting with cs_. |
| Payment page | URL | The Stripe page where the customer pays. Empty once the session expired. May be empty. |
| Status | Text | open, complete or expired. |
| Payment status | Text | paid, unpaid or no_payment_required. |
| Total | Whole number | The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty. |
| Currency | Text | The currency, for example eur. May be empty. |
| Reference | Text | The reference you gave when creating the session. May be empty. |
| Payment ID | ID | The payment (pi_...), once the customer started paying. May be empty. |
Stripe amount
An amount in one currency.
| Property | Type | Details |
|---|---|---|
| Amount | Whole number | The amount in the smallest unit of the currency, for example cents: 1000 is 10.00. |
| Currency | Text | The currency, for example eur. |
Stripe event
Everything Stripe sent about one event.
| Property | Type | Details |
|---|---|---|
| Event ID | ID | The ID of this event, starting with evt_. May be empty. |
| Event type | Text | The Stripe event type, for example checkout.session.completed. May be empty. |
| Live mode | Yes/No | True for real payments, false for test mode. May be empty. |
| API version | Text | The Stripe API version of the event. May be empty. |
| Object ID | ID | The ID of the session, charge or dispute the event is about. May be empty. |
Special types
Types whose exact shape depends on how and where they are used.
Either user or role
Either a user (or member) or a role, as a user-or-role option or picker returns it. Use "Switch on kind" to work with one kind.
Example: @Alex or @Moderators. Either one of: User, Role.
Audit log details
Extra data of an audit log entry. Which fields it has depends on the entry's action.
Either one of: Prune details, Channel and count details, Count details, Pin details, Permission overwrite details, Stage details, Command permission details, AutoMod details, Kick details, Role change details, Ban details, Member update details, Role details, Channel details.
Type
A type written as a name, or as a list or lookup table together with the type of its items.
Any
Any value of any type.
Storage field
A storage field declared by this module or server.
Stored value
Value of a storage field. Its actual type is the type declared on the selected field.
Item
Item of the iterated list or lookup table. Its actual type is the item type of the connected collection.
Field answer
A member's answer to one modal field. Its actual type follows the field type: text inputs give text, dropdowns and checkbox groups give a list, a single checkbox gives true or false.
Shape value
A value with named, typed fields, following a shape declared by this module or server.
Shape
A shape declared by this module or server. It decides which fields the shape value has and what type each of them is.
Field of a shape value
A field of the connected shape value.
Shape value
A shape value of the selected shape. Its fields are exactly the fields that shape declares.
Field value
Value of a field of a shape value. Its actual type is the type declared for that field.
Field changes
The fields of a shape value to change, each with its new value. Fields left out keep their value.
Choice list
One of the choice lists of this server or app.
Choice
A value of the chosen choice list.
Item field
A field of the items of a list.
Matching value
A value whose type is taken from the other values connected to the same action, so every branch of the choice returns the same type.
Text builder
Text you keep appending to across many steps, including inside a loop, and read out once at the end. Unlike joining text, appending changes the builder itself instead of handing back new text. Only valid inside the run that created it.
Lookup table builder
A lookup table you keep changing across many steps, including inside a loop, and read out once at the end. Unlike the plain lookup table actions, setting on it changes the builder itself instead of handing back a new lookup table. Only valid inside the run that created it.
List builder
A list you keep adding to across many steps, including inside a loop, and read out once at the end. Unlike the plain list actions, adding to it changes the builder itself instead of handing back a new list. Only valid inside the run that created it.
Number builder
A running total you keep adding to across many steps, including inside a loop, and read out once at the end. It also remembers how many times you added, so you can work out an average. Only valid inside the run that created it.