Passa al contenuto principale

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.

NameDetails
Basic typesPlain values such as text, numbers, yes/no values and times.
Lists and lookup tablesLists 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 listsValues that are picked from a fixed list of choices.
ObjectsThings such as channels, members or messages. Each has fields you can read in your flow.
Special typesTypes 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.

ValueNameDetails
GUILD_TEXTText channelA regular text channel on your server.
GUILD_ANNOUNCEMENTAnnouncement channelAn announcement channel that members can follow.
GUILD_VOICEVoice channelA voice channel on your server.
GUILD_STAGE_VOICEStage channelA stage channel for moderated audio events.
GUILD_CATEGORYCategoryA category that groups other channels.
GUILD_DIRECTORYDirectoryA directory channel, only found in Student Hub servers.
GUILD_FORUMForum channelA forum channel containing posts as threads.
GUILD_MEDIAMedia channelA media channel similar to a forum.
ANNOUNCEMENT_THREADAnnouncement threadA thread inside an announcement channel.
PUBLIC_THREADPublic threadA public thread inside a text or forum channel.
PRIVATE_THREADPrivate threadA private, invite-only thread.
DMDirect messageA 1:1 direct message channel.
GROUP_DMGroup DMA group direct message channel.

Permission​

A Discord permission flag.

ValueNameDetails
VIEW_CHANNELView channelAllows viewing a channel.
MANAGE_CHANNELSManage channelsAllows creating, editing and deleting channels.
MANAGE_ROLESManage rolesAllows creating, editing and deleting roles.
MANAGE_GUILDManage serverAllows changing server settings.
ADMINISTRATORAdministratorGrants every permission and bypasses channel overrides.
VIEW_AUDIT_LOGView audit logAllows reading the audit log.
VIEW_GUILD_INSIGHTSView server insightsAllows viewing server insights.
MANAGE_WEBHOOKSManage webhooksAllows creating, editing and deleting webhooks.
MANAGE_GUILD_EXPRESSIONSManage expressionsAllows managing emojis, stickers and soundboards.
MANAGE_EVENTSManage eventsAllows creating, editing and ending scheduled events.
CREATE_INSTANT_INVITECreate inviteAllows creating invites to the server.
CREATE_EVENTSCreate eventsAllows creating scheduled events and editing or deleting your own.
CREATE_GUILD_EXPRESSIONSCreate expressionsAllows creating emojis, stickers and soundboard sounds, and editing or deleting your own.
MANAGE_EMOJIS_AND_STICKERSManage emojis and stickers (old name)The older name of Manage expressions. Discord reports both for the same permission.
VIEW_CREATOR_MONETIZATION_ANALYTICSView creator monetization analyticsAllows viewing the insights of the server's role subscriptions.
KICK_MEMBERSKick membersAllows kicking members from the server.
BAN_MEMBERSBan membersAllows banning members from the server.
MODERATE_MEMBERSTime out membersAllows timing members out.
MANAGE_NICKNAMESManage nicknamesAllows changing other members' nicknames.
CHANGE_NICKNAMEChange own nicknameAllows changing the bot's own nickname.
SEND_MESSAGESSend messagesAllows sending messages in text channels.
SEND_MESSAGES_IN_THREADSSend messages in threadsAllows posting messages inside threads.
EMBED_LINKSEmbed linksAllows embedded links in messages.
ATTACH_FILESAttach filesAllows uploading files in messages.
ADD_REACTIONSAdd reactionsAllows reacting to messages with emojis.
MENTION_EVERYONEMention everyoneAllows using @everyone, @here and role mentions.
USE_EXTERNAL_EMOJISUse external emojisAllows using emojis from other servers.
USE_EXTERNAL_STICKERSUse external stickersAllows using stickers from other servers.
READ_MESSAGE_HISTORYRead message historyAllows reading older messages in a channel.
MANAGE_MESSAGESManage messagesAllows deleting and pinning messages.
MANAGE_THREADSManage threadsAllows archiving, locking and deleting threads.
CREATE_PUBLIC_THREADSCreate public threadsAllows creating public threads.
CREATE_PRIVATE_THREADSCreate private threadsAllows creating private threads.
SEND_TTS_MESSAGESSend TTS messagesAllows sending text-to-speech messages.
SEND_VOICE_MESSAGESSend voice messagesAllows sending voice messages.
SEND_POLLSCreate pollsAllows creating message polls.
PIN_MESSAGESPin messagesAllows pinning and unpinning messages.
BYPASS_SLOWMODEBypass slowmodeAllows sending messages without waiting for the channel's slowmode.
CONNECTConnectAllows joining voice channels.
SPEAKSpeakAllows speaking in voice channels.
STREAMVideoAllows streaming video and screen-share.
USE_VADUse voice activityAllows speaking without push-to-talk.
MUTE_MEMBERSMute membersAllows muting other members in voice channels.
DEAFEN_MEMBERSDeafen membersAllows deafening other members in voice channels.
MOVE_MEMBERSMove membersAllows moving members between voice channels.
PRIORITY_SPEAKERPriority speakerAllows priority speaker mode.
REQUEST_TO_SPEAKRequest to speakAllows requesting to speak in stage channels.
USE_SOUNDBOARDUse soundboardAllows using the soundboard in voice channels.
USE_EXTERNAL_SOUNDSUse external soundsAllows using sounds from other servers.
USE_APPLICATION_COMMANDSUse application commandsAllows running slash commands and context menus.
USE_EMBEDDED_ACTIVITIESUse activitiesAllows starting embedded voice activities.
USE_EXTERNAL_APPSUse external appsAllows interacting with apps from other servers.

Button style​

Visual style of a Discord button.

ValueNameDetails
PRIMARYPrimary (blue)Highlighted blurple button.
SECONDARYSecondary (grey)Muted grey button.
SUCCESSSuccess (green)Green button for confirmations.
DANGERDanger (red)Red button for destructive actions.
LINKLinkButton that opens an external URL.
PREMIUMPremiumButton that links to a premium SKU.

Text input style​

Display style of a modal text input.

ValueNameDetails
SHORTShortSingle-line text input.
PARAGRAPHParagraphMulti-line text input.

Verification level​

Server verification level for new members.

ValueNameDetails
NONENoneNo verification required.
LOWLowMember must have a verified email.
MEDIUMMediumMember must be on Discord for at least 5 minutes.
HIGHHighMember must be on the server for at least 10 minutes.
VERY_HIGHVery highMember must have a verified phone number.

Explicit content filter​

How Discord scans messages for explicit content.

ValueNameDetails
DISABLEDDisabledNo scanning at all.
MEMBERS_WITHOUT_ROLESMembers without rolesScan messages from members without any role.
ALL_MEMBERSAll membersScan messages from every member.

Two-factor requirement​

Whether moderation actions require 2FA.

ValueNameDetails
NONENot requiredModerators may act without 2FA.
ELEVATEDRequiredModerators must have 2FA enabled.

Default notifications​

How members are notified about messages by default.

ValueNameDetails
ALL_MESSAGESAll messagesNotify on every new message.
ONLY_MENTIONSOnly mentionsNotify only on mentions.

Activity type​

Kind of bot status activity to display.

ValueNameDetails
PLAYINGPlaying"Playing X".
STREAMINGStreaming"Streaming X" with a Twitch/YouTube URL.
LISTENINGListening"Listening to X".
WATCHINGWatching"Watching X".
CUSTOMCustom statusFree-form custom status.
COMPETINGCompeting"Competing in X".

Presence status​

Online status for the bot.

ValueNameDetails
ONLINEOnlineShown as online.
IDLEIdleShown as idle (away).
DNDDo not disturbShown as do not disturb.
INVISIBLEInvisibleAppears offline to other users.
OFFLINEOfflineThe user is offline.

Event privacy​

Who can see a scheduled event.

ValueNameDetails
GUILD_ONLYServer onlyVisible only to server members.

Event location type​

Where a scheduled event takes place.

ValueNameDetails
STAGE_INSTANCEStageInside a stage channel.
VOICEVoice channelInside a voice channel.
EXTERNALExternalAt a custom external location.

Event status​

Current state of a scheduled event.

ValueNameDetails
SCHEDULEDScheduledThe event has not yet started.
ACTIVEActiveThe event is currently running.
COMPLETEDCompletedThe event has ended.
CANCELEDCancelledThe event was cancelled.

AutoMod event​

Which event an AutoMod rule listens to.

ValueNameDetails
MESSAGE_SENDMessage sendTriggers when a message is sent.
MEMBER_UPDATEMember updateTriggers when a member's profile is updated.

AutoMod trigger​

How an AutoMod rule decides to fire.

ValueNameDetails
KEYWORDKeywordMatch a list of keywords.
SPAMSpamDiscord's built-in spam detection.
KEYWORD_PRESETKeyword presetMatch against Discord's preset keyword sets.
MENTION_SPAMMention spamTrigger on excessive mentions in a single message.
MEMBER_PROFILEMember profileMatch against member profile content.

Stage privacy​

Who can join a stage instance.

ValueNameDetails
PUBLICPublicOpen to everyone (deprecated by Discord).
GUILD_ONLYServer onlyOpen only to server members.

Message match​

How the message-created trigger matches a message.

ValueNameDetails
ANYAny messageFire on every message.
CONTAINSContainsFire when the message contains the pattern.
EQUALSEqualsFire when the message exactly equals the pattern.
STARTS_WITHStarts withFire when the message starts with the pattern.
ENDS_WITHEnds withFire when the message ends with the pattern.
REGEXRegexFire when the message matches the regex.

Audit log event​

A specific kind of audit log entry.

ValueNameDetails
GUILD_UPDATEServer updatedServer settings were changed.
CHANNEL_CREATEChannel createdA channel was created.
CHANNEL_UPDATEChannel updatedA channel was updated.
CHANNEL_DELETEChannel deletedA channel was deleted.
CHANNEL_OVERWRITE_CREATEPermission overwrite createdA channel permission overwrite was added.
CHANNEL_OVERWRITE_UPDATEPermission overwrite updatedA channel permission overwrite was updated.
CHANNEL_OVERWRITE_DELETEPermission overwrite deletedA channel permission overwrite was removed.
MEMBER_KICKMember kickedA member was kicked.
MEMBER_PRUNEMembers prunedInactive members were pruned.
MEMBER_BAN_ADDMember bannedA member was banned.
MEMBER_BAN_REMOVEMember unbannedA member was unbanned.
MEMBER_UPDATEMember updatedA member's profile was updated.
MEMBER_ROLE_UPDATEMember roles updatedA member's roles were changed.
MEMBER_MOVEMember movedA member was moved between voice channels.
MEMBER_DISCONNECTMember disconnectedA member was disconnected from voice.
BOT_ADDBot addedA bot was added to the server.
ROLE_CREATERole createdA role was created.
ROLE_UPDATERole updatedA role was updated.
ROLE_DELETERole deletedA role was deleted.
INVITE_CREATEInvite createdAn invite was created.
INVITE_UPDATEInvite updatedAn invite was updated.
INVITE_DELETEInvite deletedAn invite was deleted.
WEBHOOK_CREATEWebhook createdA webhook was created.
WEBHOOK_UPDATEWebhook updatedA webhook was updated.
WEBHOOK_DELETEWebhook deletedA webhook was deleted.
EMOJI_CREATEEmoji createdAn emoji was uploaded.
EMOJI_UPDATEEmoji updatedAn emoji was renamed.
EMOJI_DELETEEmoji deletedAn emoji was deleted.
MESSAGE_DELETEMessage deletedA message was deleted by a moderator.
MESSAGE_BULK_DELETEMessages bulk-deletedMessages were bulk-deleted.
MESSAGE_PINMessage pinnedA message was pinned.
MESSAGE_UNPINMessage unpinnedA message was unpinned.
INTEGRATION_CREATEIntegration createdAn integration was added.
INTEGRATION_UPDATEIntegration updatedAn integration was updated.
INTEGRATION_DELETEIntegration deletedAn integration was removed.
STAGE_INSTANCE_CREATEStage startedA stage instance was started.
STAGE_INSTANCE_UPDATEStage updatedA stage instance was updated.
STAGE_INSTANCE_DELETEStage endedA stage instance was ended.
STICKER_CREATESticker createdA sticker was uploaded.
STICKER_UPDATESticker updatedA sticker was updated.
STICKER_DELETESticker deletedA sticker was deleted.
GUILD_SCHEDULED_EVENT_CREATEEvent createdA scheduled event was created.
GUILD_SCHEDULED_EVENT_UPDATEEvent updatedA scheduled event was updated.
GUILD_SCHEDULED_EVENT_DELETEEvent deletedA scheduled event was deleted.
THREAD_CREATEThread createdA thread was created.
THREAD_UPDATEThread updatedA thread was updated.
THREAD_DELETEThread deletedA thread was deleted.
AUTO_MODERATION_RULE_CREATEAutoMod rule createdAn AutoMod rule was created.
AUTO_MODERATION_RULE_UPDATEAutoMod rule updatedAn AutoMod rule was updated.
AUTO_MODERATION_RULE_DELETEAutoMod rule deletedAn AutoMod rule was deleted.
AUTO_MODERATION_BLOCK_MESSAGEAutoMod blocked messageAutoMod blocked a message.
AUTO_MODERATION_FLAG_TO_CHANNELAutoMod flagged messageAutoMod flagged a message to the alert channel.
AUTO_MODERATION_USER_COMMUNICATION_DISABLEDAutoMod timed member outAutoMod timed a member out.
AUTO_MODERATION_QUARANTINE_USERAutoMod quarantined memberAutoMod quarantined a member.
APPLICATION_COMMAND_PERMISSION_UPDATECommand permissions updatedSomeone changed who may use an application command.
SOUNDBOARD_SOUND_CREATESoundboard sound createdSomeone added a soundboard sound.
SOUNDBOARD_SOUND_UPDATESoundboard sound updatedSomeone changed a soundboard sound.
SOUNDBOARD_SOUND_DELETESoundboard sound deletedSomeone removed a soundboard sound.
CREATOR_MONETIZATION_REQUEST_CREATEDMonetization requestedSomeone applied for creator monetization.
CREATOR_MONETIZATION_TERMS_ACCEPTEDMonetization terms acceptedSomeone accepted the creator monetization terms.
ONBOARDING_PROMPT_CREATEOnboarding question createdSomeone added a question to onboarding.
ONBOARDING_PROMPT_UPDATEOnboarding question updatedSomeone changed an onboarding question.
ONBOARDING_PROMPT_DELETEOnboarding question deletedSomeone removed an onboarding question.
ONBOARDING_CREATEOnboarding set upSomeone set up onboarding for the server.
ONBOARDING_UPDATEOnboarding updatedSomeone changed the server's onboarding settings.
HOME_SETTINGS_CREATEServer Guide set upSomeone set up the Server Guide.
HOME_SETTINGS_UPDATEServer Guide updatedSomeone changed the Server Guide.

Overwrite target type​

Whether a permission overwrite applies to a role or to a specific server member.

ValueNameDetails
ROLERoleThe overwrite applies to a role.
MEMBERMemberThe overwrite applies to an individual server member.

Mention kind​

Whether a Discord mention refers to a user, a role, or a channel.

ValueNameDetails
USERUserA user mention (<@id> or <@!id>).
ROLERoleA role mention (<@&id>).
CHANNELChannelA channel mention (<#id>).

Video quality mode​

Camera video quality mode for a voice channel.

ValueNameDetails
AUTOAutoDiscord chooses the optimal video quality automatically.
FULLFull (720p)Force a constant 720p video quality.

Sort order​

Default ordering for posts inside a forum or media channel.

ValueNameDetails
LATEST_ACTIVITYLatest ActivitySort posts by the most recent activity.
CREATION_DATECreation DateSort posts by their creation date.

Forum layout​

Default visual layout used to display posts in a forum channel.

ValueNameDetails
NOT_SETNot SetLet Discord pick the default layout.
LIST_VIEWList ViewDisplay posts as a compact list.
GALLERY_VIEWGallery ViewDisplay posts as a grid of media tiles.

Auto archive duration​

How long without activity before threads are auto-archived (in minutes).

ValueNameDetails
601 HourArchive threads after one hour of inactivity.
14401 DayArchive threads after 24 hours of inactivity.
43203 DaysArchive threads after 3 days of inactivity.
100801 WeekArchive threads after 7 days of inactivity.

Channel flag​

Bit-flags that toggle individual channel features.

ValueNameDetails
PINNEDPinnedThe thread is pinned at the top of its parent forum.
REQUIRE_TAGRequire TagPosts in this forum must include at least one tag.
HIDE_MEDIA_DOWNLOAD_OPTIONSHide Media Download OptionsHide 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.

ValueNameDetails
SUPPRESS_JOIN_NOTIFICATIONSSuppress join notificationsHide member join messages in the system channel.
SUPPRESS_PREMIUM_SUBSCRIPTIONSSuppress premium subscriptionsHide server boost messages in the system channel.
SUPPRESS_GUILD_REMINDER_NOTIFICATIONSSuppress server remindersHide server setup tip notifications in the system channel.
SUPPRESS_JOIN_NOTIFICATION_REPLIESSuppress join notification stickersHide the wave sticker reply prompt on join messages.
SUPPRESS_ROLE_SUBSCRIPTION_PURCHASE_NOTIFICATIONSSuppress role subscription purchasesHide role subscription purchase notifications in the system channel.
SUPPRESS_ROLE_SUBSCRIPTION_PURCHASE_NOTIFICATION_REPLIESSuppress role subscription repliesHide reply prompts on role subscription purchase notifications.

AutoMod action type​

The kind of action AutoMod takes when a rule is triggered.

ValueNameDetails
BLOCK_MESSAGEBlock messageBlock the offending message and optionally show a custom message to the author.
SEND_ALERT_MESSAGESend alert messageSend an alert about the trigger to a designated channel.
TIMEOUTTimeout memberTime the member out for a specified duration.
BLOCK_MEMBER_INTERACTIONBlock member interactionPrevent 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.

ValueNameDetails
PROFANITYProfanityWords considered swearing or cursing.
SEXUAL_CONTENTSexual contentWords referring to sexually explicit behavior or activity.
SLURSSlursPersonal 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).

ValueNameDetails
CHAT_INPUTSlash commandA standard chat-input slash command.
USERUser context menuA user-targeted context menu command.
MESSAGEMessage context menuA message-targeted context menu command.
PRIMARY_ENTRY_POINTPrimary entry pointThe primary launch entry point for an Activity.

Slash command option type​

The data type of a slash command option.

ValueNameDetails
SUB_COMMANDSub commandA nested sub command.
SUB_COMMAND_GROUPSub command groupA group of sub commands.
STRINGTextText input.
INTEGERWhole numberWhole number input.
BOOLEANYes/NoYes/No input.
USERUserA Discord user.
MEMBERServer memberA 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).
CHANNELChannelA server channel.
ROLERoleA server role.
MENTIONABLEEither User or RoleA user or role.
NUMBERDecimal numberDecimal number input.
ATTACHMENTAttachmentA file attachment.

Dropdown type​

The kind of dropdown component.

ValueNameDetails
STRINGDropdownA dropdown with custom options.
USERUser dropdownA dropdown of users.
ROLERole dropdownA dropdown of roles.
CHANNELChannel dropdownA dropdown of channels.
MENTIONABLEUser-or-role dropdownA dropdown of users and roles.

The kind of field a pop-up form (modal) shows the member.

ValueNameDetails
TEXT_INPUTText inputA single text box the member types into.
STRING_SELECTDropdownA dropdown where the member picks from options you define.
USER_SELECTMember pickerA dropdown where the member picks one or more members.
ROLE_SELECTRole pickerA dropdown where the member picks one or more roles.
CHANNEL_SELECTChannel pickerA dropdown where the member picks one or more channels.
MENTIONABLE_SELECTMember or role pickerA dropdown where the member picks members or roles.
CHECKBOXCheckboxA single yes/no tickbox, for example agreeing to the rules.
CHECKBOX_GROUPCheckbox groupA list of tickboxes where one or more options can be picked.
RADIO_GROUPRadio groupA list where exactly one option can be picked.
FILE_UPLOADFile uploadLets the member attach one or more files.
TEXT_DISPLAYText displayRead-only text shown in the form. It collects no answer.

Entitlement type​

The type of an entitlement (premium SKU purchase, gift, subscription, etc.).

ValueNameDetails
APPLICATION_SUBSCRIPTIONApp subscriptionA recurring subscription to this bot, billed by Discord.
PURCHASEOne-time purchaseThe member bought this item once and keeps it.
PREMIUM_SUBSCRIPTIONNitro subscriptionThe member has it because they subscribe to Discord Nitro.
DEVELOPER_GIFTGift from the developerHanded out for free by the people who made the bot.
TEST_MODE_PURCHASETest purchaseCreated for testing. No real money was paid.
FREE_PURCHASEFree itemThe member claimed this item while it cost nothing.
USER_GIFTGift from another memberSomeone else bought this item and gifted it to the member.
PREMIUM_PURCHASEFree for Nitro membersThe 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.

ValueNameDetails
STRINGTextAny text, such as a name, a reason or a whole message.
INTEGERWhole numberA whole number with no decimals, such as 5 or -12.
FLOATNumberA number that may have decimals, such as 2.5.
BOOLEANYes/NoA simple yes-or-no value.
SNOWFLAKEDiscord IDThe long number Discord uses to identify a user, channel, role or message.
URLURLA web address, starting with http:// or https://.
COLORColorA color, written as a hex code such as #5865F2.
DATETIMEDate & timeA specific moment in time, with both a date and a clock time.
DURATIONDurationA length of time, such as 10 minutes or 2 days.
DISCORD_USERDiscord userA Discord account. Works even for people who are not on your server.
GUILD_MEMBERServer memberSomeone who is on your server, including their nickname and roles.
GUILD_CHANNELServer channelA channel on your server.
GUILD_ROLEServer roleA role on your server.
IDIDAn identifier kept exactly as written, such as a Discord ID or an id from another service.
BIGINTBig whole numberA whole number of any size, kept exact.
ARRAYListA list of values. Choose what each item is in Content type.
MAPLookup tableValues looked up by text keys. Choose what each value is in Content type.

Component type​

Identifies the kind of Discord message component (Components V2).

ValueNameDetails
ACTION_ROWAction RowA row container for buttons or a single dropdown.
BUTTONButtonA clickable button component.
STRING_SELECTDropdownA dropdown with predefined options.
TEXT_INPUTText InputA text input field used inside modals.
USER_SELECTUser dropdownA dropdown populated with users.
ROLE_SELECTRole dropdownA dropdown populated with roles.
MENTIONABLE_SELECTUser-or-role dropdownA dropdown populated with users and roles.
CHANNEL_SELECTChannel dropdownA dropdown populated with channels.
SECTIONSectionA V2 section grouping text with an accessory.
TEXT_DISPLAYText DisplayA V2 text display component.
THUMBNAILThumbnailA V2 thumbnail component used as a section accessory.
MEDIA_GALLERYMedia GalleryA V2 gallery of up to 10 media items.
FILEFileA V2 file attachment component.
SEPARATORSeparatorA V2 spacing separator with optional divider line.
CONTAINERContainerA V2 container that groups other components with an accent color.

Separator spacing​

Controls the vertical spacing applied by a separator component.

ValueNameDetails
SMALLSmallSmall gap between adjacent components.
LARGELargeLarge gap between adjacent components.

Application flag​

A public flag describing capabilities or settings of a Discord application.

ValueNameDetails
EMBEDDEDEmbeddedThe application is embedded within the Discord client (Activity).
GATEWAY_PRESENCEGateway PresenceApproved to receive presence updates over the gateway.
GATEWAY_PRESENCE_LIMITEDGateway Presence (Limited)Awaiting approval to receive presence updates over the gateway.
GATEWAY_GUILD_MEMBERSGateway Server MembersApproved to receive server members events over the gateway.
GATEWAY_GUILD_MEMBERS_LIMITEDGateway Server Members (Limited)Awaiting approval to receive server members events over the gateway.
VERIFICATION_PENDING_GUILD_LIMITVerification Pending Server LimitHit the unusual growth criteria preventing verification.
EMBEDDED_FIRST_PARTYEmbedded First PartyThe embedded application is built by Discord itself.
GATEWAY_MESSAGE_CONTENTGateway Message ContentApproved to receive message content over the gateway.
GATEWAY_MESSAGE_CONTENT_LIMITEDGateway Message Content (Limited)Awaiting approval to receive message content over the gateway.
APPLICATION_COMMAND_BADGEApplication Command BadgeThe application has registered global application commands.
ACTIVE_DEVELOPERActive DeveloperThe application owner has the Active Developer badge.
EMBEDDED_RELEASEDEmbedded (released)The application's Activity is released to everyone.
MANAGED_EMOJIManaged emojiDiscord marks the application as able to use managed emojis.
EMBEDDED_IAPEmbedded in-app purchasesThe application's Activity can offer in-app purchases.
GROUP_DM_CREATECreate group DMsThe application can create group direct messages.
APPLICATION_AUTO_MODERATION_RULE_CREATE_BADGEAutoMod badgeThe application has created enough AutoMod rules to show the AutoMod badge.
RPC_HAS_CONNECTEDHas used RPCThe application has connected to the Discord client through RPC.

SKU type​

The category of a Discord SKU.

ValueNameDetails
DURABLEDurableA one-time purchase that does not get consumed.
CONSUMABLEConsumableA one-time purchase that is consumed by the application.
SUBSCRIPTIONSubscriptionA recurring subscription.
SUBSCRIPTION_GROUPSubscription GroupA system-generated group containing related subscription SKUs.

Subscription status​

The current status of a Discord subscription.

ValueNameDetails
ACTIVEActiveThe subscription is active and renewing.
ENDINGEndingThe subscription is active until the end of the current period.
INACTIVEInactiveThe subscription is no longer active.

Role connection metadata type​

Comparison operator used by Discord to evaluate role connection metadata against role requirements.

ValueNameDetails
INTEGER_LESS_THAN_OR_EQUALWhole number <= Server ValueMetadata value (whole number) is less than or equal to the server's configured value.
INTEGER_GREATER_THAN_OR_EQUALWhole number >= Server ValueMetadata value (whole number) is greater than or equal to the server's configured value.
INTEGER_EQUALWhole number = Server ValueMetadata value (whole number) equals the server's configured value.
INTEGER_NOT_EQUALWhole number != Server ValueMetadata value (whole number) does not equal the server's configured value.
DATETIME_LESS_THAN_OR_EQUALDateTime <= Server ValueMetadata value (datetime) is less than or equal to the server's configured value, in days.
DATETIME_GREATER_THAN_OR_EQUALDateTime >= Server ValueMetadata value (datetime) is greater than or equal to the server's configured value, in days.
BOOLEAN_EQUALYes/No = Server ValueMetadata value (yes/no) equals the server's configured value.
BOOLEAN_NOT_EQUALYes/No != Server ValueMetadata 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.

ValueNameDetails
GUILDServerThe entitlement is owned by a server (server-wide).
USERUserThe entitlement is owned by a single user.

Onboarding prompt type​

The interaction style used by an onboarding prompt.

ValueNameDetails
MULTIPLE_CHOICEMultiple ChoicePrompt rendered as a set of selectable buttons or cards.
DROPDOWNDropdownPrompt rendered as a dropdown list.

Onboarding mode​

Controls which channels and roles count toward Discord's onboarding requirements.

ValueNameDetails
ONBOARDING_DEFAULTDefaultCounts only default channels toward onboarding constraints.
ONBOARDING_ADVANCEDAdvancedCounts 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.

ValueNameDetails
ROLERolePermission targets a specific role.
USERUserPermission targets a specific user.
CHANNELChannelPermission targets a specific channel (or all channels via the @everyone-channel sentinel).

Sort direction​

Direction entries are sorted in.

ValueNameDetails
ASCAscendingSmallest values first.
DESCDescendingLargest values first.

Aggregate operation​

Which aggregate to compute over a field's values.

ValueNameDetails
SUMSumTotal of all numeric values.
AVGAverageMean of all numeric values.
COUNTCountNumber of entries.
MINMinimumSmallest numeric value.
MAXMaximumLargest numeric value.
MEDIANMedianMiddle numeric value.

Pick weighting​

How entries are weighted when drawing at random.

ValueNameDetails
NONEUniformEvery key is equally likely.
VALUEBy valueMore likely the higher the entry's value (a raffle by ticket count).

Comparison​

How the current value is compared to a threshold.

ValueNameDetails
GTEAt least (≥)Current value is greater than or equal to the threshold.
GTGreater than (>)Current value is strictly greater than the threshold.
LTEAt most (≤)Current value is less than or equal to the threshold.
LTLess than (<)Current value is strictly less than the threshold.
EQEqual to (=)Current value equals the threshold.

Condition​

What must be true of the currently stored value for the new value to be written.

ValueNameDetails
ABSENTOnly if nothing is storedWrites 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.
PRESENTOnly if something is storedWrites only when there already is a value. Use it to update an existing entry without ever creating a new one.
EQUALSOnly if it equalsWrites 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_EQUALSOnly if it does not equalWrites 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.

ValueNameDetails
COMPACTCompactShort letter units, e.g. "2h 30m".
LONGLongSpelled-out units, e.g. "2 hours 30 minutes".
LARGEST_UNITLargest unitOnly the largest unit, e.g. "3 hours".

Number style​

How a number is rendered as text.

ValueNameDetails
GROUPEDGroupedThousands separators, e.g. "4,000,000".
COMPACTCompactAbbreviated units, e.g. "4M".
COMPACT_LONGCompact (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.

ValueNameDetails
tShort timeThe time only, e.g. "16:20".
TLong timeThe time with seconds, e.g. "16:20:30".
dShort dateThe date in digits, e.g. "20/04/2021".
DLong dateThe date with the month written out, e.g. "20 April 2021".
fShort date and timeDate and time, e.g. "20 April 2021 16:20".
FLong date and timeWeekday, date and time, e.g. "Tuesday, 20 April 2021 16:20".
RRelativeHow 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.

ValueNameDetails
shieldShieldA small badge with the Discord logo and the number of members online.
banner1Banner 1A large banner with the server icon, name and members online, and "Powered by Discord" at the bottom.
banner2Banner 2A smaller banner with the server icon, name and members online, and the Discord logo on the right.
banner3Banner 3A large banner with the server icon, name and members online, and a "Chat now" link at the bottom.
banner4Banner 4A 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.

ValueNameDetails
USERUserA member or user, mentioned as <@123>.
ROLERoleA server role, mentioned as <@&123>.
CHANNELChannelA channel, linked as <#123>.

Component cleanup​

What happens to the watched buttons/dropdowns once a wait finishes.

ValueNameDetails
DISABLEDisableKeep the components visible but greyed out.
REMOVERemoveRemove the components from the message.
KEEPKeepLeave the components untouched.
RESETResetClear 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.

ValueNameDetails
MISSING_PERMISSIONSMissing permissionsThe bot lacks the required permissions.
DISCORD_API_ERRORDiscord API errorDiscord rejected the request.
INVALID_INPUTInvalid inputAn input had an invalid value.
NOT_FOUNDNot foundThe requested resource does not exist.
STORAGE_ERRORStorage errorA storage operation failed.
LIMIT_EXCEEDEDLimit exceededAn execution limit was exceeded.
TIMEOUTTimeoutThe operation took too long.
UNKNOWNUnknownAn unexpected error occurred.
INTERACTION_EXPIREDInteraction expiredThe interaction expired before the bot responded (roughly a 3-second window). Defer or reply sooner, or use the defer guard.
AI_CREDITS_EXHAUSTEDOut of AI CoinsThis 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_TIMEOUTHTTP timeoutThe web API did not answer in time.
HTTP_UNREACHABLEHTTP unreachableThe web API could not be reached: the address does not exist, refused the connection or has a broken certificate.
HTTP_RESPONSE_TOO_LARGEHTTP response too largeThe answer was larger than 1 MB.
HTTP_RATE_LIMITEDHTTP rate limitedToo many requests in a short time. Try again later.
HTTP_UNAVAILABLEHTTP unavailableOutgoing requests are not available right now.

HTTP method​

How an HTTP request treats the address.

ValueNameDetails
GETGETRead data.
POSTPOSTSend new data.
PUTPUTReplace data.
PATCHPATCHChange part of the data.
DELETEDELETEDelete data.

Body​

What an HTTP request or webhook answer sends along.

ValueNameDetails
NONENoneSend no body.
JSONJSONSend a value as JSON.
FORMFormSend names and values as a URL-encoded form.
RAWTextSend 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.

ValueNameDetails
STRINGTextAny text, such as a name, a reason or a whole message.
FLOATNumberA number, with or without decimals.
BOOLEANYes/NoA simple yes-or-no value.
DISCORD_USERDiscord userA Discord account. Works even for people who are not on your server.
GUILD_MEMBERServer memberSomeone who is on your server, including their nickname and roles.
GUILD_ROLEServer roleA role on your server.
GUILD_CHANNELServer channelA channel on your server.
IDIDAn identifier kept exactly as written, such as a Discord ID or an id from another service.
BIGINTBig whole numberA 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.

ValueNameDetails
ADDAdda plus b.
SUBTRACTSubtracta minus b.
MULTIPLYMultiplya times b.
DIVIDEDividea divided by b, rounded toward zero. Dividing by zero fails.
MODULORemainderWhat 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.

ValueNameDetails
ALLAll timeCount every recorded run (subject to retention).
DAYLast 24 hoursCount runs from the last 24 hours.
WEEKLast 7 daysCount runs from the last 7 days.

Character set​

Which characters random text may contain.

ValueNameDetails
ALPHANUMERICLetters and digitsA-Z, a-z and 0-9.
ALPHABETICLetters onlyA-Z and a-z.
NUMERICDigits only0-9.
HEXADECIMALHexadecimal0-9 and a-f.

Thread privacy​

Whether to fetch public or private archived threads.

ValueNameDetails
PUBLICPublicPublic archived threads.
PRIVATEPrivatePrivate 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.

PropertyTypeDetails
IDDiscord IDThe Discord ID of the channel. Example: 345678901234567890.
NameTextThe name of the channel. May be empty. Example: general.
TypeChannel typeThe kind of channel.
URLURLJump-to URL of the channel.
Created atDate and timeWhen the channel was created. May be empty.

Server channel​

A channel that lives on a server.

Example: #general. Builds on: Channel.

PropertyTypeDetails
ServerServerThe server this channel belongs to.
CategoryCategoryThe category this channel sits in. May be empty.
PositionWhole numberPosition of the channel in the channel list.
Permissions syncedYes/NoWhether permissions are synced with the parent category. May be empty.
ManageableYes/NoWhether the bot can manage this channel.
ViewableYes/NoWhether the bot can see this channel.
DeletableYes/NoWhether the bot can delete this channel.

Category​

A category that groups channels.

Builds on: Server channel.

PropertyTypeDetails
ChannelsList of Server channelChannels inside this category.

Text channel​

A text channel on your server.

Builds on: Server channel.

PropertyTypeDetails
TopicTextThe channel topic. Maximum length: 1024 characters. May be empty.
NSFWYes/NoWhether this channel is marked age-restricted.
SlowmodeDurationRate limit per user.
Default auto-archiveDurationDefault auto-archive duration for new threads. May be empty.
Default thread slowmodeDurationDefault slowmode for new threads in this channel. May be empty.
Last messageMessageThe 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.

PropertyTypeDetails
BitrateWhole numberAudio bitrate (8000 - 384000). Value: 8000 to 384000.
User limitWhole numberMaximum number of users (0 = unlimited). Value: 0 to 99.
RTC regionTextVoice region override. May be empty.
Members in voiceList of Server memberMembers currently connected to this voice channel.
FullYes/NoWhether the user limit is reached.
JoinableYes/NoWhether the bot can join this channel.
SpeakableYes/NoWhether the bot can speak in this channel.

Stage channel​

A stage channel for moderated audio events.

Builds on: Voice channel.

PropertyTypeDetails
Active stageStage instanceThe currently running stage instance, if any. May be empty.
TopicTextTopic of the channel. May be empty.

Forum tag​

A tag that can be applied to forum posts.

PropertyTypeDetails
IDDiscord IDID of the tag.
NameTextDisplay name of the tag. Maximum length: 20 characters.
Moderator onlyYes/NoWhether only moderators can apply this tag.
EmojiTextEmoji shown next to the tag. May be empty.

Forum channel​

A forum channel containing posts as threads.

Builds on: Server channel.

PropertyTypeDetails
TopicTextChannel topic. Maximum length: 4096 characters. May be empty.
NSFWYes/NoWhether this forum is age-restricted.
Available tagsList of Forum tagTags that can be applied to posts. Maximum items: 20.
Default auto-archiveDurationDefault auto-archive duration for new posts. May be empty.
Default post slowmodeDurationDefault 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.

PropertyTypeDetails
OwnerServer memberMember that started the thread. May be empty.
Parent channelServer channelThe channel this thread lives in. May be empty.
ArchivedYes/NoWhether the thread is archived. May be empty.
LockedYes/NoWhether the thread is locked. May be empty.
Auto-archiveDurationWhen the thread auto-archives. May be empty.
Archived atDate and timeWhen the thread was last archived. May be empty.
InvitableYes/NoWhether non-moderators can invite to a private thread. May be empty.
JoinedYes/NoWhether the bot has joined this thread.
Member countWhole numberNumber of members in the thread. May be empty.
Message countWhole numberApproximate number of messages in the thread. May be empty.
Applied tagsList of Forum tagForum tags applied to this post.

Direct message​

A direct message channel.

Builds on: Channel.

PropertyTypeDetails
RecipientUserUser the bot is talking to. May be empty.

User​

A Discord user account.

Example: Alex (@alex).

PropertyTypeDetails
IDDiscord IDDiscord ID of the user. Example: 123456789012345678.
UsernameTextLogin username. Example: alex.
Global nameTextDiscord display name (may be empty). May be empty.
Display nameTextThe user's display name (global name, or the username if empty). Example: Alex.
DiscriminatorTextLegacy discriminator ("0" for migrated users).
Avatar URLURLURL of the user's avatar. May be empty.
Banner URLURLURL of the user's banner. May be empty.
Accent colorColorProfile accent color. May be empty.
Is botYes/NoWhether the user is a bot.
Is Discord systemYes/NoWhether the user is a Discord system account.
TagTextUsername with discriminator (legacy format).
MentionTextMention text for use in messages. Example: @Alex.
Created atDate and timeWhen the account was created.

Server member​

A user in the context of a specific server.

Example: Alex on this server. Builds on: User.

PropertyTypeDetails
ServerServerServer this member belongs to.
NicknameTextServer nickname (may be empty). Maximum length: 32 characters. May be empty. Example: Lexi.
Display nameTextBest display name (nickname > global > username). Example: Alex.
Display avatarURLBest display avatar URL.
Display colorColorColor from the highest-coloured role.
Joined atDate and timeWhen the member joined the server. May be empty.
Boosting sinceDate and timeWhen the member started boosting the server. May be empty.
Timeout untilDate and timeWhen the member's timeout ends. May be empty.
Pending screeningYes/NoWhether the member still needs to pass membership screening.
RolesList of RoleRoles assigned to the member. Example: @Moderators, @Members.
Highest roleRoleThe member's highest role by position (at minimum @everyone).
PermissionsList of PermissionEffective permissions of the member.
KickableYes/NoWhether the bot can kick this member.
BannableYes/NoWhether the bot can ban this member.
ModeratableYes/NoWhether the bot can time this member out.
ManageableYes/NoWhether the bot can manage this member.
Voice stateVoice stateCurrent voice state, if connected.

Role​

A role on your server.

Example: @Moderators.

PropertyTypeDetails
IDDiscord IDRole ID. Example: 234567890123456789.
NameTextDisplay name of the role. Maximum length: 100 characters. Example: Moderators.
ColorColorRole color.
PositionWhole numberPosition in the role list.
Display separatelyYes/NoWhether members with the role appear separately.
Anyone can mentionYes/NoWhether the role can be @mentioned.
ManagedYes/NoWhether the role is managed by an integration.
Icon URLURLURL of the role icon. May be empty.
Unicode emojiTextUnicode emoji used as the role icon. May be empty.
PermissionsList of PermissionPermissions granted by the role.
MembersList of Server memberMembers that have this role. Example: Alex, Sam.
MentionTextMention text for use in messages.
Created atDate and timeWhen the role was created.

Server​

A Discord server.

PropertyTypeDetails
IDDiscord IDServer ID.
NameTextServer name. Maximum length: 100 characters.
DescriptionTextServer description. May be empty.
Icon URLURLURL of the server icon. May be empty.
Banner URLURLURL of the server banner. May be empty.
Splash URLURLURL of the invite splash image. May be empty.
OwnerServer memberServer owner. May be empty.
Member countWhole numberTotal number of members.
Boost levelWhole numberThe server boost level (0-3).
Boost countWhole numberNumber of active boosts, or empty when unknown. May be empty.
Preferred localeTextServer-preferred locale.
Verification levelVerification levelRequired verification level for new members.
Content filterExplicit content filterExplicit content filter setting.
Default notificationsDefault notificationsDefault notification setting.
2FA requirementTwo-factor requirementWhether moderation requires 2FA.
Vanity codeTextServer vanity invite code. May be empty.
AFK channelVoice channelChannel members are moved to when idle. May be empty.
AFK timeoutDurationIdle time before moving to the AFK channel. May be empty.
System channelText channelChannel that receives Discord system messages. May be empty.
Rules channelText channelChannel containing server rules. May be empty.
Public updates channelText channelChannel that receives public Discord updates. May be empty.
Safety alerts channelText channelChannel that receives safety alerts. May be empty.
RolesList of RoleAll roles on the server.
ChannelsList of Server channelAll channels on the server.
Members by IDLookup table of Discord ID to Server memberLookup table of member ID to member.
Created atDate and timeWhen the server was created.
Everyone roleRoleThe default @everyone role of the server.

Attachment​

A file attached to a message.

PropertyTypeDetails
IDDiscord IDAttachment ID.
File nameTextFile name as uploaded.
DescriptionTextAlt text or description. Maximum length: 1024 characters. May be empty.
Content typeTextMIME content type. May be empty.
SizeWhole numberFile size in bytes.
URLURLURL of the attachment.
Proxy URLURLDiscord-proxied URL.
HeightWhole numberImage height in pixels (if applicable). May be empty.
WidthWhole numberImage width in pixels (if applicable). May be empty.
EphemeralYes/NoWhether the attachment is part of an ephemeral message.
DurationDurationDuration of the audio (for voice messages). May be empty.

Embed field​

A name/value field inside an embed.

PropertyTypeDetails
Field nameTextBold field title (max 256 characters). Length: 1 to 256 characters.
Field valueTextField body text (max 1024 characters). Length: 1 to 1024 characters.
InlineYes/NoWhether the field appears side-by-side. Default: No.

Footer of an embed.

PropertyTypeDetails
Footer textTextFooter text. Length: 1 to 2048 characters.
Footer icon URLURLSmall icon shown next to the footer. May be empty.

Embed author​

Author block of an embed.

PropertyTypeDetails
Author nameTextDisplay name of the author. Length: 1 to 256 characters.
Author URLURLURL the name links to. May be empty.
Author icon URLURLSmall icon shown next to the author. May be empty.

Embed​

A rich embed attached to a message.

PropertyTypeDetails
TitleTextEmbed title (max 256 characters). Maximum length: 256 characters. May be empty.
DescriptionTextEmbed description (max 4096 characters). Maximum length: 4096 characters. May be empty.
URLURLURL the title links to. May be empty.
ColorColorSide-bar color of the embed. May be empty.
TimestampDate and timeFooter timestamp. May be empty.
Image URLURLLarge image displayed in the embed. May be empty.
Thumbnail URLURLSmall thumbnail in the top right. May be empty.
FooterEmbed footerFooter of the embed. May be empty.
AuthorEmbed authorAuthor block of the embed. May be empty.
FieldsList of Embed fieldUp to 25 name/value fields. Maximum items: 25. Default: [].

Button​

A button attached to a message.

PropertyTypeDetails
LabelTextText shown on the button (max 80 characters). Maximum length: 80 characters. May be empty.
EmojiTextEmoji shown on the button. May be empty.
StyleButton styleVisual style. Default: Primary (blue)
DisabledYes/NoWhether the button is greyed out. Default: No.
Custom IDTextOptional 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 flowFlowFlow to run when this button is clicked. Use only one of these: URL. May be empty.
URLURLURL 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.

PropertyTypeDetails
Allow @everyoneYes/NoWhether @everyone and @here may ping. Default: No.
Allow role mentionsYes/NoWhether role mentions may ping. Default: Yes.
Allow user mentionsYes/NoWhether user mentions may ping. Default: Yes.
Pingable usersList of UserSpecific users that may be pinged (overrides "Allow user mentions"). Maximum items: 100.
Pingable rolesList of RoleSpecific roles that may be pinged (overrides "Allow role mentions"). Maximum items: 100.
Mention replied userYes/NoWhether replying to a message pings the original author. Default: Yes.

Message content​

The full payload of a message: text, embeds, buttons and files.

PropertyTypeDetails
TextTextPlain text body of the message (max 2000 characters). Maximum length: 2000 characters. May be empty.
EmbedsList of EmbedUp to 10 rich embeds. Maximum items: 10. Default: [].
ButtonsList of ButtonButtons attached to the message. Maximum items: 25. Default: [].
FilesList of AttachmentFiles to attach to the message. Maximum items: 10. Default: [].
Text-to-speechYes/NoWhether the message should be read aloud. Default: No.
EphemeralYes/NoOnly the recipient sees the message (interactions only). Default: No.
Suppress embedsYes/NoHide embeds generated from links. Default: No.
Silent messageYes/NoSend without push notifications. Default: No.
Allowed mentionsAllowed mentionsRestrict which mentions actually ping. May be empty.

Message​

A message in a channel.

Example: Hello there, sent by Alex.

PropertyTypeDetails
IDDiscord IDMessage ID.
TextTextRaw message content. Example: Hello there.
Cleaned textTextContent with mentions resolved to display names.
ChannelText channelChannel the message was sent in.
ServerServerServer the message was sent in (none for DMs). May be empty.
AuthorUserUser that sent the message. Example: Alex (@alex).
Author (as member)Server memberAuthor resolved to a server member, when applicable. May be empty.
AttachmentsList of AttachmentFiles attached to the message.
EmbedsList of EmbedEmbeds in the message.
Mentioned usersList of UserUsers mentioned in the message.
Mentioned rolesList of RoleRoles mentioned in the message.
Mentioned channelsList of Server channelChannels mentioned in the message.
Mentions everyoneYes/NoWhether the message contains @everyone or @here.
PinnedYes/NoWhether the message is pinned.
Text-to-speechYes/NoWhether the message was sent as TTS.
System messageYes/NoWhether this is a Discord system message.
Is Components V2Yes/NoWhether the message was sent as a Components V2 message. Such messages can only be edited with Components V2 content.
Edited atDate and timeWhen the message was last edited. May be empty.
Created atDate and timeWhen the message was sent.
URLURLJump-to URL of the message.
ThreadThreadThread that was started from this message. May be empty.
Replied-to messageMessageMessage this one replies to. May be empty.
As message contentMessage contentThe 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.

PropertyTypeDetails
MemberServer memberThe member this voice state belongs to. May be empty.
ChannelVoice channelVoice channel the member is connected to. May be empty.
Session IDTextVoice session identifier. May be empty.
Server deafenedYes/NoWhether server-deafened by a moderator. May be empty.
Server mutedYes/NoWhether server-muted by a moderator. May be empty.
Self deafenedYes/NoWhether the user has deafened themselves. May be empty.
Self mutedYes/NoWhether the user has muted themselves. May be empty.
Camera onYes/NoWhether the user has video on. May be empty.
StreamingYes/NoWhether the user is screen-sharing. May be empty.
SuppressedYes/NoWhether the user is suppressed (cannot speak in stage). May be empty.
Requested to speak atDate and timeWhen the user raised their hand in stage. May be empty.

Stage instance​

A live stage event in a stage channel.

PropertyTypeDetails
IDDiscord IDStage instance ID.
ServerServerServer the stage runs on. May be empty.
Stage channelStage channelStage channel hosting the event. May be empty.
TopicTextTopic of the stage. Maximum length: 120 characters.
PrivacyStage privacyPrivacy level of the stage.
Discovery disabledYes/NoWhether the stage is hidden from discovery. May be empty.

Server emoji​

A custom emoji on your server.

PropertyTypeDetails
IDDiscord IDEmoji ID.
NameTextEmoji name.
AnimatedYes/NoWhether the emoji is animated.
ManagedYes/NoWhether the emoji is managed by an integration.
AvailableYes/NoWhether the emoji can currently be used. May be empty.
URLURLURL of the emoji image.
AuthorUserUser that uploaded the emoji. May be empty.
Allowed rolesList of RoleRoles that may use the emoji (empty = everyone).
Created atDate and timeWhen the emoji was uploaded.

Server sticker​

A custom sticker on your server.

PropertyTypeDetails
IDDiscord IDSticker ID.
NameTextSticker name. Maximum length: 30 characters.
DescriptionTextSticker description. Maximum length: 100 characters. May be empty.
TagsTextComma-separated keyword list used by autocomplete. May be empty.
AvailableYes/NoWhether the sticker can currently be used. May be empty.
URLURLURL of the sticker image.

Invite​

An invite link to your server.

PropertyTypeDetails
CodeTextInvite code.
URLURLFull invite URL.
ChannelServer channelChannel the invite leads to. May be empty.
ServerServerThe server the invite points to, or empty when unknown. May be empty.
InviterUserUser that created the invite. May be empty.
UsesWhole numberHow many times the invite has been used. May be empty.
Max usesWhole numberMaximum allowed uses (0 = unlimited). May be empty.
Max ageDurationHow long the invite is valid for. May be empty.
TemporaryYes/NoWhether members are kicked when they leave voice if they have no role. May be empty.
Expires atDate and timeWhen the invite expires. May be empty.
Created atDate and timeWhen the invite was created. May be empty.

Webhook​

A Discord webhook attached to a channel.

PropertyTypeDetails
IDDiscord IDWebhook ID.
NameTextDefault name shown for messages.
ChannelText channelChannel the webhook posts to. May be empty.
ServerServerServer the webhook belongs to. May be empty.
OwnerUserUser that created the webhook. May be empty.
Avatar URLURLDefault avatar shown for messages. May be empty.

Ban​

A ban on your server.

PropertyTypeDetails
UserUserBanned user.
ServerServerServer the ban applies to.
ReasonTextReason for the ban. May be empty.

Audit log entry​

A single entry from the server's audit log.

Example: Alex banned Sam.

PropertyTypeDetails
IDDiscord IDAudit log entry ID.
ActionAudit log eventWhat happened. Example: Member banned.
ExecutorUserWho performed the action. May be empty. Example: Alex (@alex).
Target IDDiscord IDID of the affected object. May be empty.
ReasonTextReason given for the action. May be empty. Example: Spamming links.
Created atDate and timeWhen the entry was logged.
Target TypeTextThe type of object that was targeted by this audit-log entry (e.g. user, channel, role).
ChangesList of Audit log changeA list of individual field changes recorded in this audit-log entry.
Extra DataLookup table of Text to TextAdditional metadata associated with this audit-log entry, encoded as text key and value pairs.
DetailsAudit log detailsTyped 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.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Members removedWhole numberHow many members were removed.
Inactive daysWhole numberHow many days of inactivity counted.

Channel and count details​

Details of a member move or a message deletion.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Channel IDDiscord IDThe channel the action happened in. May be empty.
CountWhole numberHow many members or messages were affected.

Count details​

Details of a bulk message deletion or a voice disconnect.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
CountWhole numberHow many messages or members were affected. Example: 12.

Pin details​

Details of pinning or unpinning a message.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Channel IDDiscord IDThe channel of the message. May be empty.
Message IDDiscord IDThe pinned or unpinned message.

Permission overwrite details​

Details of a channel permission overwrite change.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Target IDDiscord IDThe role or member the overwrite is for.
Target kindTextROLE or MEMBER.
Role nameTextThe role's name when the overwrite is for a role. May be empty. Example: Moderators.

Stage details​

Details of a stage instance change.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Channel IDDiscord IDThe stage channel. May be empty.

Command permission details​

Details of an application command permission change.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Application IDDiscord IDThe application whose command permissions changed.

AutoMod details​

Details of an AutoMod action.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Rule nameTextThe AutoMod rule that acted.
Rule trigger typeWhole numberThe rule's trigger type as Discord numbers it. May be empty.
Channel IDDiscord IDThe channel the action happened in. May be empty.

Integration details​

Details of a kick or role change made by an integration.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Integration typeTextThe type of integration that made the change.

Ban details​

Details of a ban or an unban.

Example: Sam was banned.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
User IDDiscord IDThe ID of the user who was banned or unbanned. Example: 456789012345678901.
UsernameTextThe user's name. Empty when the bot does not know the user. May be empty. Example: sam.

Kick details​

Details of a kick.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
User IDDiscord IDThe ID of the user who was kicked.
UsernameTextThe user's name. Empty when the bot does not know the user. May be empty.
Integration typeTextThe 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.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
User IDDiscord IDThe ID of the member whose roles changed.
UsernameTextThe member's name. Empty when the bot does not know the user. May be empty.
Added role IDsList of Discord IDThe IDs of the roles that were added.
Added role namesList of TextThe names of the roles that were added, in the same order.
Removed role IDsList of Discord IDThe IDs of the roles that were removed.
Removed role namesList of TextThe names of the roles that were removed, in the same order.
Integration typeTextThe 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.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
User IDDiscord IDThe ID of the member who was changed.
Nickname beforeTextThe nickname before the change. Empty when it did not change or there was none. May be empty.
Nickname afterTextThe nickname after the change. Empty when it did not change or was removed. May be empty.
Timed out untilDate and timeWhen 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.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Role IDDiscord IDThe ID of the role.
Role nameTextThe 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.

PropertyTypeDetails
ActionAudit log eventThe audit log action these details belong to.
Channel IDDiscord IDThe ID of the channel.
Channel nameTextThe 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.

PropertyTypeDetails
IDDiscord IDEvent ID.
NameTextEvent name. Maximum length: 100 characters.
DescriptionTextEvent description. Maximum length: 1000 characters. May be empty.
ChannelVoice channelVoice or stage channel the event happens in. May be empty.
CreatorUserUser that created the event. May be empty.
Location typeEvent location typeWhere the event takes place.
PrivacyEvent privacyWho can see the event.
StatusEvent statusCurrent status of the event.
Starts atDate and timeScheduled start time. May be empty.
Ends atDate and timeScheduled end time. May be empty.
Image URLURLCover image of the event. May be empty.
Interested usersWhole numberHow many users are interested in the event. May be empty.
URLURLDirect URL to the event.

AutoMod rule​

An AutoMod rule on your server.

PropertyTypeDetails
IDDiscord IDRule ID.
NameTextRule name.
CreatorUserUser that created the rule. May be empty.
EventAutoMod eventWhich event the rule listens to.
TriggerAutoMod triggerHow the rule decides to fire.
EnabledYes/NoWhether the rule is currently active.
Exempt rolesList of RoleRoles that bypass the rule.
Exempt channelsList of Server channelChannels where the rule is not enforced.

Poll answer​

One answer option of a message poll.

PropertyTypeDetails
IDWhole numberAnswer ID.
TextTextAnswer text (max 55 characters). Maximum length: 55 characters. May be empty.
EmojiTextOptional emoji shown next to the answer. May be empty.
Vote countWhole numberNumber of votes this answer has received.

Poll​

A poll attached to a message.

PropertyTypeDetails
QuestionTextPoll question (max 300 characters). Maximum length: 300 characters.
AnswersList of Poll answerAvailable answer options. Items: 1 to 10.
Expires atDate and timeWhen voting ends. May be empty.
Multi-selectYes/NoWhether voters can pick more than one answer.
Results finalYes/NoWhether the poll has ended and results are final.
Total votesWhole numberTotal 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.).

PropertyTypeDetails
IDDiscord IDInteraction ID.
UserUserUser that triggered the interaction. Example: Alex (@alex).
MemberServer memberUser as a server member, when applicable. May be empty.
ServerServerServer the interaction came from. May be empty.
ChannelServer channelChannel the interaction came from. May be empty.
User localeTextDiscord locale of the user.
Server localeTextPreferred locale of the server. May be empty.
Bot permissionsList of PermissionThe permissions the bot has in the channel of this interaction. May be empty.
Created atDate and timeWhen the interaction was created.

Button click​

An interaction caused by clicking a message button.

Builds on: Interaction.

PropertyTypeDetails
Custom IDTextCustom ID of the clicked button.
MessageMessageMessage the button was attached to.
Button labelTextLabel of the clicked button. May be empty.
StateTextState 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.

PropertyTypeDetails
Custom IDTextCustom ID of the dropdown component.
MessageMessageMessage the menu was attached to.
StateTextState text the menu carried (the custom id set on a flow-linked menu), if any. May be empty.
Selected valuesList of TextValues the user selected.

An interaction caused by submitting a modal form.

Builds on: Interaction.

PropertyTypeDetails
Custom IDTextCustom ID of the submitted modal.
FieldsLookup table of Text to AnyLookup 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.

PropertyTypeDetails
Command nameTextName of the command that was run.
SubcommandTextName of the invoked subcommand, or empty when none was used. May be empty.
Subcommand groupTextName of the invoked subcommand group, or empty when none was used. May be empty.
OptionsLookup table of Text to TextLookup table of option ID to value (as text).

Flow​

A reference to another custom command flow.

PropertyTypeDetails
IDDiscord IDFlow ID.
NameTextDisplay name of the flow.

Default reaction​

Default emoji used for reactions on posts in a forum or media channel.

PropertyTypeDetails
Emoji IDDiscord IDID of a custom server emoji to use as the default reaction. May be empty.
Emoji NameTextUnicode 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.

PropertyTypeDetails
Target IDDiscord IDID of the role or member this overwrite applies to.
Target TypeOverwrite target typeWhether the target is a role or a member.
Allowed PermissionsList of PermissionPermissions explicitly granted to the target on this channel.
Denied PermissionsList of PermissionPermissions explicitly revoked from the target on this channel.

Poll answer​

A single answer choice for a poll, with optional emoji.

PropertyTypeDetails
TextTextThe answer text shown to voters (max 55 characters). Length: 1 to 55 characters.
EmojiTextOptional 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.

PropertyTypeDetails
IDDiscord IDThe server's Discord ID.
NameTextThe server's display name.
Icon URLURLThe server icon URL, if set. May be empty.
Splash URLURLThe invite splash URL, if set. May be empty.
Discovery splash URLURLThe discovery splash URL shown in the discovery directory, if set. May be empty.
EmojisList of Server emojiAll custom emojis available in the server.
StickersList of Server stickerAll custom stickers available in the server.
FeaturesList of TextIdentifiers of features the server has enabled.
Approximate member countWhole numberAn approximate count of members in the server.
Approximate presence countWhole numberAn approximate count of online members in the server.
DescriptionTextThe 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.

PropertyTypeDetails
CodeTextThe unique template code used in invite-style URLs.
NameTextThe display name of the template.
DescriptionTextThe user-provided description of the template. May be empty.
Usage countWhole numberHow many times this template has been used.
CreatorUserThe user who created the template.
Created atDate and timeWhen the template was first created.
Updated atDate and timeWhen the template was last synced with its source server.
Source serverServerThe server this template was created from. May be empty.
Serialized source serverTextThe serialized JSON snapshot of the source server's structure. May be empty.
Is dirtyYes/NoWhether 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.

PropertyTypeDetails
IDDiscord IDThe integration's Discord ID.
NameTextThe integration's display name.
TypeTextThe kind of integration (e.g. twitch, youtube, discord).
EnabledYes/NoWhether the integration is currently enabled. May be empty.
Account IDTextThe external account ID linked through this integration. May be empty.
Account nameTextThe external account display name. May be empty.
SyncingYes/NoWhether the integration is currently being synced. May be empty.
Subscriber roleRoleThe role granted to subscribers, if applicable. May be empty.
Expire behaviorWhole numberWhat happens when subscriber benefits expire (0 = remove role, 1 = kick member). May be empty.
Expire grace periodWhole numberDays to wait before applying the expire behavior. May be empty.
UserUserThe user that added the integration. May be empty.
Synced atDate and timeWhen the integration was last synced. May be empty.
Subscriber countWhole numberNumber of subscribers linked to this integration. May be empty.
RevokedYes/NoWhether the integration has been revoked. May be empty.
Application IDDiscord IDThe Discord application ID, for bot integrations. May be empty.

Soundboard sound​

A custom soundboard sound that can be played in voice channels.

PropertyTypeDetails
IDDiscord IDThe sound's Discord ID.
NameTextThe sound's display name.
VolumeDecimal numberPlayback volume between 0.0 and 1.0.
Emoji IDDiscord IDThe custom emoji ID associated with the sound, if any. May be empty.
Emoji nameTextThe unicode emoji or custom emoji name shown next to the sound. May be empty.
Server IDDiscord IDThe server this sound belongs to (empty for default sounds). May be empty.
AvailableYes/NoWhether the sound is currently usable in the server.
UserUserThe user who uploaded the sound. May be empty.
Created atDate and timeWhen the sound was uploaded.

AutoMod action​

An action AutoMod performs when a rule is triggered.

PropertyTypeDetails
TypeAutoMod action typeThe kind of action to take.
Custom messageTextCustom explanation shown to the user when their message is blocked (BLOCK_MESSAGE only). Maximum length: 150 characters.
Alert channelText channelThe channel to send alert messages to (SEND_ALERT_MESSAGE only). May be empty.
Timeout durationDurationHow 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.

PropertyTypeDetails
Keyword filterList of TextPieces of text or wildcard patterns that trigger the rule.
Regex patternsList of TextRust-flavored regex patterns that trigger the rule.
Keyword presetsList of AutoMod keyword presetDiscord-curated keyword preset lists to enable.
Allow listList of TextPieces of text exempted from filtering.
Mention total limitWhole numberThe maximum number of unique role and user mentions allowed in a single message. Value: 1 to 50. May be empty.
Mention raid protectionYes/NoWhether to use Discord's mention raid protection heuristics.

Command option choice​

A predefined choice for a slash command option.

PropertyTypeDetails
NameTextThe label shown to users (max 100 chars). Length: 1 to 100 characters.
ValueTextThe 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.

PropertyTypeDetails
NameTextInternal name of the option (lowercase, 1-32 chars). Length: 1 to 32 characters. Must match ^[-_a-z0-9]+$.
DescriptionTextUser-facing description (1-100 chars). Length: 1 to 100 characters.
TypeSlash command option typeThe data type accepted by this option.
RequiredYes/NoWhether the user must provide this option. Default: No.
ChoicesList of Command option choicePredefined choices the user can pick from (max 25). Maximum items: 25.
Channel typesList of Channel typeRestricts channel options to specific channel types.
Min valueDecimal numberMinimum allowed numeric value. May be empty.
Max valueDecimal numberMaximum allowed numeric value. May be empty.
Min lengthWhole numberMinimum allowed text length. Value: 0 to 6000. May be empty.
Max lengthWhole numberMaximum allowed text length. Value: 1 to 6000. May be empty.
AutocompleteYes/NoEnables dynamic autocomplete suggestions for this option. Default: No. May be empty.
Static suggestionsList of TextSuggestions offered automatically as the user types - no flow required (max 100, requires autocomplete). Maximum items: 100.
Subcommands / nested optionsList of Command optionNested options for subcommands and subcommand groups (max 25). Maximum items: 25.

Application command​

A registered slash, user, or message command on Discord.

PropertyTypeDetails
IDDiscord IDDiscord ID of the command.
Application IDDiscord IDID of the application that owns this command.
TypeApplication command typeThe kind of application command.
Server IDDiscord IDID of the server this command is registered in (if any). May be empty.
NameTextName of the command (1-32 chars). Length: 1 to 32 characters.
DescriptionTextDescription of the command (max 100 chars). Maximum length: 100 characters.
OptionsList of Command optionThe options/parameters of this command. Maximum items: 25.
Default permissionsList of PermissionRequired member permissions to use this command by default.
DM permissionYes/NoWhether the command is usable in DMs. Default: Yes. May be empty.
NSFWYes/NoWhether the command is age-restricted. Default: No.
VersionDiscord IDAuto-incrementing version ID of the command.

Text input​

A text input field used inside a modal.

PropertyTypeDetails
Custom IDTextIdentifier sent back when the modal is submitted (max 100 chars). Length: 1 to 100 characters.
LabelTextLabel shown above the field (max 45 chars). Length: 1 to 45 characters.
StyleText input styleWhether the input is a single line or paragraph.
Min lengthWhole numberMinimum allowed input length (0-4000). Value: 0 to 4000. May be empty.
Max lengthWhole numberMaximum allowed input length (1-4000). Value: 1 to 4000. May be empty.
RequiredYes/NoWhether the user must fill this field. Default: Yes. May be empty.
Default valueTextPre-filled value of the field (max 4000 chars). Maximum length: 4000 characters. May be empty.
PlaceholderTextHint text shown when the field is empty (max 100 chars). Maximum length: 100 characters. May be empty.

A pop-up form with text inputs that the user can submit.

PropertyTypeDetails
Custom IDTextIdentifier sent back when the modal is submitted (max 100 chars). Length: 1 to 100 characters.
TitleTextTitle shown at the top of the modal (max 45 chars). Length: 1 to 45 characters.
ComponentsList of Form fieldThe text inputs in the modal (1-5 items). Items: 1 to 5.

Select option​

A single option in a dropdown.

PropertyTypeDetails
LabelTextLabel shown to the user (max 100 chars). Length: 1 to 100 characters.
ValueTextValue sent back when this option is chosen (max 100 chars). Length: 1 to 100 characters.
DescriptionTextOptional description shown below the label. Maximum length: 100 characters. May be empty.
EmojiTextOptional emoji displayed next to the label. May be empty.
DefaultYes/NoWhether this option is selected by default. Default: No. May be empty.
Flow to runFlowThe flow that runs when someone picks this option. Leave blank to use the menu's own flow. May be empty.

One choice in a dropdown, checkbox group or radio group of a pop-up form (modal).

PropertyTypeDetails
LabelTextText the member sees for this choice (max 100 chars). Length: 1 to 100 characters.
ValueTextValue reported back when this choice is picked (max 100 chars). Length: 1 to 100 characters.
DescriptionTextExtra line shown under the label (max 100 chars). Maximum length: 100 characters. May be empty.
Selected by defaultYes/NoWhether this choice is already picked when the modal opens. Default: No. May be empty.

A single field of a pop-up form (modal). Which settings apply depends on the field type.

PropertyTypeDetails
Field typeForm field typeThe kind of field to show. Leave empty for a text input. May be empty.
Custom IDTextIdentifier 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.
LabelTextLabel shown above the field (max 45 chars). Length: 1 to 45 characters. May be empty.
DescriptionTextHelper text shown under the label (max 100 chars). Maximum length: 100 characters. May be empty.
RequiredYes/NoWhether the member must answer this field before submitting. Default: Yes. May be empty.
PlaceholderTextGreyed-out hint shown while the field is empty (max 150 chars). Maximum length: 150 characters. May be empty.
StyleText input styleWhether a text input is a single line or a multi-line box. May be empty.
Minimum lengthWhole numberFewest characters a text input accepts. Value: 0 to 4000. May be empty.
Maximum lengthWhole numberMost characters a text input accepts. Value: 1 to 4000. May be empty.
Prefilled valueTextText the field already contains when the modal opens (max 4000 chars). Maximum length: 4000 characters. May be empty.
OptionsList of Form field optionThe choices a dropdown, checkbox group or radio group offers (max 25 items). Maximum items: 25.
Minimum selectionsWhole numberFewest options the member must pick. Value: 0 to 25. May be empty.
Maximum selectionsWhole numberMost options the member may pick. Value: 1 to 25. May be empty.
Channel typesList of Channel typeRestricts a channel picker to these kinds of channel. Empty allows all.
Minimum filesWhole numberFewest files the member must upload. Value: 1 to 10. May be empty.
Maximum filesWhole numberMost files the member may upload. Value: 1 to 10. May be empty.
Checked by defaultYes/NoWhether a single checkbox starts out checked. Default: No. May be empty.
TextTextThe 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).

PropertyTypeDetails
Custom IDTextIdentifier sent back when an option is chosen (max 100 chars). Length: 1 to 100 characters.
TypeDropdown typeThe kind of dropdown. Default: Dropdown.
PlaceholderTextHint text shown when nothing is selected. Maximum length: 150 characters. May be empty.
Min valuesWhole numberMinimum number of items the user must select (0-25). Value: 0 to 25. Default: 1. May be empty.
Max valuesWhole numberMaximum number of items the user can select (1-25). Value: 1 to 25. Default: 1. May be empty.
DisabledYes/NoWhether the menu is disabled. Default: No. May be empty.
OptionsList of Select optionThe options for a dropdown (max 25). Maximum items: 25.
Channel typesList of Channel typeRestricts a channel select to specific channel types.
Target flowFlowOptional 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.

PropertyTypeDetails
IDDiscord IDUnique ID of the entitlement.
SKU IDDiscord IDID of the SKU this entitlement grants access to.
Application IDDiscord IDID of the application that owns the SKU.
User IDDiscord IDID of the user this entitlement was granted to, if any.
Server IDDiscord IDID of the server this entitlement was granted to, if any. May be empty.
TypeEntitlement typeType of entitlement.
DeletedYes/NoWhether this entitlement has been deleted.
Starts AtDate and timeWhen the entitlement period started, if applicable. May be empty.
Ends AtDate and timeWhen the entitlement period ends, if applicable. May be empty.

Activity​

A single activity entry from a user's presence (game, listening, custom status, etc.).

PropertyTypeDetails
NameTextName of the activity (e.g. game title, song title).
TypeActivity typeWhat kind of activity this is (Playing, Streaming, Listening, ...).
URLURLStream URL, only present for streaming activities. May be empty.
DetailsTextWhat the user is currently doing inside the activity. May be empty.
StateTextUser-defined state, e.g. the text of a custom status. May be empty.
Application IDDiscord IDID of the application this activity belongs to, if any. May be empty.
Created AtDate and timeTimestamp when this activity started.

Presence​

A user's presence in a server: online status, activities and per-client status.

PropertyTypeDetails
User IDDiscord IDID of the user this presence belongs to.
Server IDDiscord IDID of the server this presence is from. May be empty.
StatusPresence statusOverall online status (online, idle, dnd, offline, invisible).
ActivitiesList of ActivityList of activities the user currently has.
Desktop StatusPresence statusStatus on the desktop client, if connected. May be empty.
Mobile StatusPresence statusStatus on the mobile client, if connected. May be empty.
Web StatusPresence statusStatus on the web client, if connected. May be empty.

User dropdown interaction​

An interaction created when a user submits a user dropdown.

PropertyTypeDetails
Custom IDTextCustom ID of the dropdown component.
MessageMessageMessage the menu was attached to.
StateTextState text the menu carried (the custom id set on a flow-linked menu), if any. May be empty.
Selected UsersList of UserUsers that were selected.
Selected MembersList of Server memberServer members corresponding to the selected users, when available.

Role dropdown interaction​

An interaction created when a user submits a role dropdown.

PropertyTypeDetails
Custom IDTextCustom ID of the dropdown component.
MessageMessageMessage the menu was attached to.
StateTextState text the menu carried (the custom id set on a flow-linked menu), if any. May be empty.
Selected RolesList of RoleRoles that were selected.

Channel dropdown interaction​

An interaction created when a user submits a channel dropdown.

PropertyTypeDetails
Custom IDTextCustom ID of the dropdown component.
MessageMessageMessage the menu was attached to.
StateTextState text the menu carried (the custom id set on a flow-linked menu), if any. May be empty.
Selected ChannelsList of Server channelChannels that were selected.

User-or-role dropdown interaction​

An interaction created when a user submits a user-or-role dropdown (users and roles).

PropertyTypeDetails
Custom IDTextCustom ID of the dropdown component.
MessageMessageMessage the menu was attached to.
StateTextState text the menu carried (the custom id set on a flow-linked menu), if any. May be empty.
Selected UsersList of UserUsers selected in the menu.
Selected RolesList of RoleRoles selected in the menu.

User context menu interaction​

An interaction created when a user runs a user context-menu command.

PropertyTypeDetails
Command NameTextName of the context-menu command that was used.
Target UserUserUser the command was used on.
Target MemberServer memberServer 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.

PropertyTypeDetails
Command NameTextName of the context-menu command that was used.
Target MessageMessageMessage the command was used on.

Autocomplete interaction​

An interaction representing an autocomplete request for a slash-command option.

PropertyTypeDetails
Command NameTextName of the slash command that triggered autocomplete.
Focused Option NameTextName of the option the user is currently typing in. May be empty.
Focused Option ValueTextCurrent partial value the user has typed. May be empty.
SubcommandTextName of the subcommand the user is typing in, or empty when the command has none. May be empty.
Subcommand GroupTextName 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.

PropertyTypeDetails
IDTextStable 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-]+$.
TypeFlow parameter typeType of the value. Callers must pass a compatible value.
Content typeTypeFor a list or lookup table: the type of each item. Lists and lookup tables may be nested.
OptionalYes/NoWhether callers may omit this parameter. Default: No. May be empty.
DescriptionTextHint 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.

PropertyTypeDetails
URLURLThe source URL of the media. May reference an attachment via attachment://filename.
HeightWhole numberPixel height of the media (filled by Discord on responses). May be empty.
WidthWhole numberPixel width of the media (filled by Discord on responses). May be empty.
Content TypeTextMIME type of the media (filled by Discord on responses). May be empty.
Attachment IDDiscord IDDiscord ID of the attached file, if backed by an upload. May be empty.
Proxy URLURLDiscord's proxied URL for the media (filled on responses). May be empty.

A single image or video entry inside a media gallery component.

PropertyTypeDetails
MediaMedia itemThe underlying media item (URL or attachment reference).
DescriptionTextAlt text for accessibility (max 1024 characters). Maximum length: 1024 characters. May be empty.
SpoilerYes/NoWhether the item should be marked as a spoiler. Default: No.

Thumbnail component​

A small media accessory shown next to a section's text content.

PropertyTypeDetails
MediaMedia itemThe image or video shown as the thumbnail.
DescriptionTextAlt text for accessibility (max 1024 characters). Maximum length: 1024 characters. May be empty.
SpoilerYes/NoWhether the thumbnail should be marked as a spoiler. Default: No.

File component​

A Components V2 file block that displays an attached file inline.

PropertyTypeDetails
FileMedia itemThe media item to display (typically an attachment:// reference).
SpoilerYes/NoWhether the file should be marked as a spoiler. Default: No.
NameTextDisplay name (filled by Discord on responses). May be empty.
SizeWhole numberFile size in bytes (filled by Discord on responses). May be empty.

Separator component​

A vertical spacer with an optional divider line.

PropertyTypeDetails
DividerYes/NoWhether to render a thin horizontal line. Default: Yes.
SpacingSeparator spacingHow much vertical space the separator takes. Default: Small.

Text display component​

A Components V2 text block supporting markdown (max 4000 characters).

PropertyTypeDetails
ContentTextMarkdown text rendered by the client. Maximum length: 4000 characters.

Section component​

Groups one to three text-display children with an accessory (thumbnail or button).

PropertyTypeDetails
Text DisplaysList of Text display component1-3 text-display children rendered as the section body. Items: 1 to 3.
Accessory (Thumbnail)Thumbnail componentUse 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)ButtonUse a button as the section's accessory. Provide either this or a thumbnail. Use only one of these: Accessory (Thumbnail) May be empty.

A grid of 1-10 images or videos.

PropertyTypeDetails
ItemsList of Media gallery itemThe 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.

PropertyTypeDetails
ButtonsList of ButtonUp 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.
DropdownDropdownA 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 dropdownUser dropdownA 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 dropdownRole dropdownA 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 dropdownChannel dropdownA 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 dropdownUser-or-role dropdownA 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.

PropertyTypeDetails
Accent ColorColorColor shown as the container's left edge. May be empty.
SpoilerYes/NoWhether the entire container is hidden behind a spoiler. Default: No.
Text DisplaysList of Text display componentText-display children placed in the container. Default: [].
SectionsList of Section componentSection children placed in the container. Default: [].
Media GalleriesList of Media gallery componentMedia gallery children placed in the container. Default: [].
SeparatorsList of Separator componentSeparator children placed in the container. Default: [].
FilesList of File componentFile children placed in the container. Default: [].
Action RowsList of Action row componentAction row children placed in the container. Default: [].

User dropdown​

A dropdown auto-populated with users from the server.

PropertyTypeDetails
Target FlowFlowFlow to invoke when a selection is made. May be empty.
PlaceholderTextPlaceholder text shown when nothing is selected (max 150). Maximum length: 150 characters. May be empty.
Min ValuesWhole numberMinimum number of selectable users (0-25). Value: 0 to 25. Default: 1.
Max ValuesWhole numberMaximum number of selectable users (1-25). Value: 1 to 25. Default: 1.
DisabledYes/NoWhether the menu is rendered as disabled. Default: No.
Default UsersList of UserUp to 25 users pre-selected when the menu first appears. Maximum items: 25.

Role dropdown​

A dropdown auto-populated with roles from the server.

PropertyTypeDetails
Target FlowFlowFlow to invoke when a selection is made. May be empty.
PlaceholderTextPlaceholder text shown when nothing is selected (max 150). Maximum length: 150 characters. May be empty.
Min ValuesWhole numberMinimum number of selectable roles (0-25). Value: 0 to 25. Default: 1.
Max ValuesWhole numberMaximum number of selectable roles (1-25). Value: 1 to 25. Default: 1.
DisabledYes/NoWhether the menu is rendered as disabled. Default: No.
Default RolesList of RoleUp to 25 roles pre-selected when the menu first appears. Maximum items: 25.

Channel dropdown​

A dropdown auto-populated with channels from the server.

PropertyTypeDetails
Target FlowFlowFlow to invoke when a selection is made. May be empty.
PlaceholderTextPlaceholder text shown when nothing is selected (max 150). Maximum length: 150 characters. May be empty.
Min ValuesWhole numberMinimum number of selectable channels (0-25). Value: 0 to 25. Default: 1.
Max ValuesWhole numberMaximum number of selectable channels (1-25). Value: 1 to 25. Default: 1.
DisabledYes/NoWhether the menu is rendered as disabled. Default: No.
Default ChannelsList of Server channelUp to 25 channels pre-selected when the menu first appears. Maximum items: 25.
Channel TypesList of Channel typeRestrict selectable channels to these types.

User-or-role dropdown​

A dropdown auto-populated with both users and roles.

PropertyTypeDetails
Target FlowFlowFlow to invoke when a selection is made. May be empty.
PlaceholderTextPlaceholder text shown when nothing is selected (max 150). Maximum length: 150 characters. May be empty.
Min ValuesWhole numberMinimum number of selectable users or roles (0-25). Value: 0 to 25. Default: 1.
Max ValuesWhole numberMaximum number of selectable users or roles (1-25). Value: 1 to 25. Default: 1.
DisabledYes/NoWhether the menu is rendered as disabled. Default: No.
Default UsersList of UserUp to 25 users pre-selected when the menu first appears. Maximum items: 25.
Default RolesList of RoleUp 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.

PropertyTypeDetails
ScopesList of TextOAuth2 scopes requested when installing the application.
PermissionsList of PermissionPermissions requested for the bot when installed.

Application​

The Discord application this bot belongs to, including all public metadata.

PropertyTypeDetails
IDDiscord IDThe unique Discord ID of the application.
NameTextThe display name of the application.
Icon URLURLThe URL to the application's icon image. May be empty.
DescriptionTextThe description shown on the application's profile.
RPC OriginsList of TextList of allowed RPC origin URLs.
Bot PublicYes/NoWhether the bot can be added by anyone or only the owner. May be empty.
Bot Requires Code GrantYes/NoWhether the bot requires the OAuth2 code grant flow to be added. May be empty.
Terms of Service URLURLThe URL of the application's terms of service. May be empty.
Privacy Policy URLURLThe URL of the application's privacy policy. May be empty.
OwnerUserThe user who owns the application, if individually owned. May be empty.
Verify KeyTextHex-encoded key for verification in interactions and the GameSDK.
Team NameTextName of the team that owns the application, if any. May be empty.
Server IDDiscord IDServer associated with the application (e.g. support server). May be empty.
Primary SKU IDDiscord IDThe ID of the primary SKU of a game sold on Discord, if any. May be empty.
SlugTextURL slug used by the application's store page. May be empty.
Cover Image URLURLThe URL of the application's default rich-presence cover image. May be empty.
FlagsList of Application flagPublic flags describing capabilities and settings of the application.
Approximate Server CountWhole numberApproximate number of servers the application has been added to. May be empty.
Approximate User Install CountWhole numberApproximate number of users that have installed the application. May be empty.
Install ParametersApplication install parametersDefault in-app authorization parameters. May be empty.
Custom Install URLURLCustom URL Discord redirects users to for installing the app. May be empty.
Role Connections Verification URLURLURL Discord opens to verify role connections. May be empty.
TagsList of TextUp 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.

PropertyTypeDetails
TypeRole connection metadata typeComparison operator used to evaluate this field.
KeyTextInternal dictionary key (a-z, 0-9, underscore, max 50 chars). Maximum length: 50 characters. Must match ^[a-z0-9_]+$.
NameTextHuman-readable name shown to users (max 100 chars). Maximum length: 100 characters.
DescriptionTextHuman-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.

PropertyTypeDetails
IDDiscord IDThe unique Discord ID of the SKU.
TypeSKU typeThe category of the SKU (durable, consumable, subscription, ...).
Application IDDiscord IDThe ID of the parent application.
NameTextCustomer-facing name of the SKU.
SlugTextURL-friendly identifier for the SKU.
FlagsList of TextFlags applied to the SKU.

Subscription​

A user's subscription to one or more SKUs of this application.

PropertyTypeDetails
IDDiscord IDThe unique Discord ID of the subscription.
User IDDiscord IDID of the user who is subscribed.
SKU IDsList of Discord IDList of SKUs the user is currently subscribed to.
Entitlement IDsList of Discord IDList of entitlements granted by this subscription.
Current Period StartDate and timeWhen the current billing period started.
Current Period EndDate and timeWhen the current billing period ends.
StatusSubscription statusThe current status of the subscription.
Canceled AtDate and timeWhen the subscription was canceled, if applicable. May be empty.
CountryTextISO3166-1 alpha-2 country code of the payment source. Only present when querying as the subscribed user. May be empty.
Renewal SKU IDsList of Discord IDList 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).

PropertyTypeDetails
IDDiscord IDThe unique Discord ID of the emoji.
NameTextThe emoji's name.
AnimatedYes/NoWhether the emoji is animated.
AvailableYes/NoWhether the emoji is currently usable.
URLURLDirect URL to the emoji's image.
Created AtDate and timeWhen the emoji was created.
AuthorUserThe 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.

PropertyTypeDetails
KeyTextThe name of the field that changed (e.g. "name", "permissions").
Old ValueTextThe previous value of the field, saved as text. May be empty if the field was newly set. May be empty.
New ValueTextThe 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.

PropertyTypeDetails
ChannelServer channelThe channel highlighted on the welcome screen. May be empty.
DescriptionTextShort description shown next to the channel (max 50 characters). Maximum length: 50 characters.
Emoji IDDiscord IDDiscord ID of a custom emoji shown next to the channel, or empty when using a unicode emoji. May be empty.
Emoji NameTextName 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.

PropertyTypeDetails
DescriptionTextServer description shown on the welcome screen (max 140 characters). May be empty. Maximum length: 140 characters. May be empty.
Welcome ChannelsList of Welcome screen channelUp 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.

PropertyTypeDetails
Option IDDiscord IDDiscord ID of this prompt option.
Channel IDsList of Discord IDChannels granted to the member when this option is selected.
Role IDsList of Discord IDRoles granted to the member when this option is selected.
Emoji IDDiscord IDDiscord ID of the custom emoji on the option, or empty when using a unicode emoji. May be empty.
Emoji NameTextCustom emoji name, or the unicode emoji character. May be empty.
Emoji AnimatedYes/NoWhether the emoji is animated. May be empty.
TitleTextTitle of the option (max 50 characters). Maximum length: 50 characters.
DescriptionTextOptional 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.

PropertyTypeDetails
Prompt IDDiscord IDDiscord ID of this prompt.
TypeOnboarding prompt typeWhether the prompt is rendered as multiple choice or as a dropdown.
OptionsList of Onboarding prompt optionSelectable answers (1-50). Items: 1 to 50.
TitleTextTitle of the prompt (max 100 characters). Maximum length: 100 characters.
Single SelectYes/NoWhether only one option may be selected.
RequiredYes/NoWhether the user must answer this prompt before completing onboarding.
In OnboardingYes/NoWhether 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.

PropertyTypeDetails
Server IDDiscord IDDiscord ID of the server this onboarding belongs to.
PromptsList of Onboarding promptOnboarding prompts shown to new members.
Default Channel IDsList of Discord IDChannels every member sees by default. At least seven are required. Minimum items: 7.
EnabledYes/NoWhether onboarding is currently enabled.
ModeOnboarding modeWhether 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.

PropertyTypeDetails
Target IDDiscord IDDiscord ID of the role, user or channel this overwrite targets.
TypeApplication command permission typeWhether the target is a role, user or channel.
PermissionYes/NoTrue 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).

PropertyTypeDetails
Command IDDiscord IDDiscord ID of the application command, or of the application itself for default command permissions.
Application IDDiscord IDDiscord ID of the application that owns the command.
Server IDDiscord IDDiscord ID of the server these permissions apply to.
PermissionsList of Application command permissionUp 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.

PropertyTypeDetails
ChannelServer channelThe channel being repositioned.
PositionWhole numberThe new sort position.
Lock PermissionsYes/NoWhen true, syncs the channel's permissions with the new parent category. May be empty.
Parent IDDiscord IDDiscord 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.

PropertyTypeDetails
RoleRoleThe role being repositioned.
PositionWhole numberThe new sort position.

Storage entry​

A single entry of a storage field.

PropertyTypeDetails
SubjectTextUser ID or key the value is stored under.
ValueStored valueThe stored value.
RankWhole numberPosition 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.

PropertyTypeDetails
UserUserThe resolved Discord user, or empty if that user no longer exists. No separate fetch step is needed. May be empty.
User IDDiscord IDThe stable Discord user ID stored with this entry.

Execution summary​

A summary of one recorded flow execution.

PropertyTypeDetails
NumberWhole numberThe execution number.
StatusTextHow the run ended (e.g. SUCCESS, FAILED, STOPPED).
TimestampDate and timeWhen the run was recorded.
TriggerTextThe trigger type that started the run.

Scheduled run​

A flow run that has been scheduled but has not happened yet.

PropertyTypeDetails
Run IDTextHandle for this scheduled run. Pass it to "Cancel scheduled flow run".
Target flowTextThe flow that will run.
Run atDate and timeWhen the run will happen.

Lookup table entry​

A single key and value pair of a lookup table.

Example: Red team: 120.

PropertyTypeDetails
KeyTextThe key this pair is stored under. Example: Red team.
ValueStored valueThe value stored under that key. Example: 120.

top.gg vote​

One vote for your project on top.gg.

PropertyTypeDetails
User IDDiscord IDThe Discord ID of the user who voted.
top.gg user IDIDThe ID of the user on top.gg.
WeightWhole numberHow much the vote counts: 2 for weekend votes, otherwise 1.
Voted atDate and timeWhen the user voted.
Expires atDate and timeWhen the vote stops counting, 12 hours after it was cast.

top.gg vote event​

Everything top.gg sent about one vote.

PropertyTypeDetails
Vote IDIDThe ID of this vote on top.gg. Empty for test events. May be empty.
User IDDiscord IDThe Discord ID of the user who voted.
UsernameTextThe Discord username of the user who voted. May be empty.
Avatar URLURLThe avatar image of the user who voted. May be empty.
WeightWhole numberHow much the vote counts: 2 for weekend votes, otherwise 1. Empty for test events. May be empty.
Voted atDate and timeWhen the user voted. Empty for test events. May be empty.
Expires atDate and timeWhen the vote stops counting. Empty for test events. May be empty.
Bot or server IDDiscord IDThe Discord ID of the bot or server that got the vote.

Twitch clip​

One clip of a Twitch channel.

PropertyTypeDetails
Clip IDIDThe ID of the clip.
LinkURLThe address of the clip.
TitleTextThe title of the clip.
Clipped byTextThe name of the user who made the clip.
ViewsWhole numberHow often the clip was watched.
Created atDate and timeWhen the clip was made.
Length in secondsDecimal numberHow long the clip is, in seconds.
Preview imageURLThe preview image of the clip. May be empty.

Forecast day​

The weather forecast for one day.

PropertyTypeDetails
DayDate and timeMidnight at the start of the day, in the place's time zone.
Weather codeWhole numberThe 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 temperatureDecimal numberThe highest temperature of the day. May be empty.
Lowest temperatureDecimal numberThe lowest temperature of the day. May be empty.
Precipitation in mmDecimal numberRain, showers and snow of the day together, in millimeters. May be empty.
Chance of rain in %Whole numberThe highest chance of precipitation during the day, in percent. May be empty.
Strongest windDecimal numberThe highest wind speed of the day, in the chosen unit. May be empty.
SunriseDate and timeWhen the sun rises. May be empty.
SunsetDate and timeWhen the sun sets. May be empty.

CoinGecko coin​

One coin in the market list.

PropertyTypeDetails
Coin IDIDThe CoinGecko API ID, for example bitcoin.
SymbolTextThe ticker symbol, for example btc.
NameTextThe name of the coin.
LogoURLThe logo of the coin. Empty when it has none. May be empty.
PriceDecimal numberThe price in the chosen currency. May be empty.
Market capDecimal numberThe market cap in the chosen currency. May be empty.
RankWhole numberThe place by market cap. May be empty.
Change in 24 hours in %Decimal numberHow much the price changed in the last 24 hours, in percent. May be empty.

Anime​

One anime on MyAnimeList.

PropertyTypeDetails
MyAnimeList IDIDThe ID of the anime on MyAnimeList.
LinkURLThe MyAnimeList page.
TitleTextThe main title.
English titleTextThe English title, when there is one. May be empty.
TypeTextTV, Movie, OVA, ONA, Special or Music. May be empty.
StatusTextFinished Airing, Currently Airing or Not yet aired. May be empty.
ScoreDecimal numberThe average score from 1 to 10. May be empty.
RankWhole numberThe place by score on MyAnimeList. May be empty.
SynopsisTextThe English summary. May be empty.
Cover imageURLThe cover image. May be empty.
EpisodesWhole numberHow many episodes it has, when known. May be empty.
YearWhole numberThe year it started airing, when known. May be empty.

Manga​

One manga on MyAnimeList.

PropertyTypeDetails
MyAnimeList IDIDThe ID of the manga on MyAnimeList.
LinkURLThe MyAnimeList page.
TitleTextThe main title.
English titleTextThe English title, when there is one. May be empty.
TypeTextManga, Novel, Light Novel, One-shot, Doujinshi, Manhwa or Manhua. May be empty.
StatusTextFinished, Publishing, On Hiatus, Discontinued or Not yet published. May be empty.
ScoreDecimal numberThe average score from 1 to 10. May be empty.
RankWhole numberThe place by score on MyAnimeList. May be empty.
SynopsisTextThe English summary. May be empty.
Cover imageURLThe cover image. May be empty.
ChaptersWhole numberHow many chapters it has, when known. May be empty.
VolumesWhole numberHow many volumes it has, when known. May be empty.

GitHub issue​

One issue or pull request of a repository.

PropertyTypeDetails
NumberWhole numberThe issue number, for example 1347.
TitleTextThe title.
LinkURLThe issue on GitHub.
StateTextopen or closed.
AuthorTextThe username of the author. May be empty.
CommentsWhole numberHow many comments it has. May be empty.
Created atDate and timeWhen it was opened.
Pull request linkURLThe pull request on GitHub. Empty for issues, so use it to tell them apart. May be empty.

GitHub release​

One release of a repository.

PropertyTypeDetails
TagTextThe tag of the release, for example v1.0.0.
NameTextThe name of the release. May be empty.
LinkURLThe release on GitHub.
Release notesTextThe release notes, as Markdown. May be empty.
Published atDate and timeWhen it was published. Empty for drafts. May be empty.
Pre-releaseYes/NoWhether it is marked as a pre-release.
DraftYes/NoWhether it is a draft.

Roblox group role​

One role (rank) of a Roblox group.

PropertyTypeDetails
Role IDIDThe ID of the role.
NameTextThe name of the role.
RankWhole numberThe rank number, 0 to 255. The owner has 255.
MembersWhole numberHow many members have the role, when the key may see it. May be empty.
DescriptionTextThe description of the role. May be empty.

Roblox group member​

One member of a Roblox group and their role.

PropertyTypeDetails
Roblox user IDIDThe Roblox user ID of the member.
Role IDIDThe ID of the member's role.
Joined atDate and timeWhen the member joined. May be empty.

Roblox group membership​

A group a user is in and their role there.

PropertyTypeDetails
Group IDIDThe ID of the group.
Group nameTextThe name of the group.
Role IDIDThe ID of the user's role.
Role nameTextThe name of the user's role.
RankWhole numberThe rank number of the role, 1 to 255.

Airtable row​

One row of an Airtable table.

PropertyTypeDetails
Row IDIDThe ID of the row, starting with rec.
Created atDate and timeWhen the row was created.
FieldsLookup table of Text to TextThe field values by field name, as text. Empty fields and list, attachment and collaborator fields are left out.

Todoist task​

One Todoist task.

PropertyTypeDetails
Task IDIDThe ID of the task.
TaskTextThe task text.
DescriptionTextThe description. May be empty.
Project IDIDThe project the task is in. May be empty.
PriorityWhole number1 (normal) to 4 (urgent). Todoist shows 4 as P1. May be empty.
Due dateTextThe due date like 2026-10-20, or a date and time. Empty without a due date. May be empty.
Due textTextThe due date as written, for example every monday. May be empty.
LabelsList of TextThe label names. May be empty.
Created atDate and timeWhen the task was added. May be empty.

Steam game​

A game a Steam user owns.

PropertyTypeDetails
App IDIDThe Steam app ID of the game.
NameTextThe name of the game. May be empty.
Playtime in minutesWhole numberAll playtime, in minutes.
Last two weeks in minutesWhole numberPlaytime in the last two weeks, in minutes. Empty when not played. May be empty.
Last playedDate and timeWhen it was last played. May be empty.

Stripe charge​

One charge.

PropertyTypeDetails
IDIDThe ID, starting with ch_.
AmountWhole numberThe amount in the smallest unit of the currency, for example cents: 1000 is 10.00.
CurrencyTextThe currency, for example eur.
StatusTextsucceeded, pending or failed.
Created atDate and timeWhen it was created.
DescriptionTextThe description, when set. May be empty.
Customer IDIDThe customer, when there is one. May be empty.
PaidYes/NoWhether the charge went through.
Fully refundedYes/NoWhether all of it was refunded.
Refunded amountWhole numberThe amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty.
EmailTextThe billing email, when given. May be empty.
ReceiptURLThe receipt page. May be empty.

Stripe payment​

One payment intent.

PropertyTypeDetails
IDIDThe ID, starting with pi_.
AmountWhole numberThe amount in the smallest unit of the currency, for example cents: 1000 is 10.00.
CurrencyTextThe currency, for example eur.
StatusTextsucceeded, processing, requires_payment_method, requires_action, canceled or another step.
Created atDate and timeWhen it was created.
DescriptionTextThe description, when set. May be empty.
Customer IDIDThe customer, when there is one. May be empty.
Received amountWhole numberThe amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty.

Stripe checkout session​

One Checkout session.

PropertyTypeDetails
IDIDThe ID, starting with cs_.
Payment pageURLThe Stripe page where the customer pays. Empty once the session expired. May be empty.
StatusTextopen, complete or expired.
Payment statusTextpaid, unpaid or no_payment_required.
TotalWhole numberThe amount in the smallest unit of the currency, for example cents: 1000 is 10.00. May be empty.
CurrencyTextThe currency, for example eur. May be empty.
ReferenceTextThe reference you gave when creating the session. May be empty.
Payment IDIDThe payment (pi_...), once the customer started paying. May be empty.

Stripe amount​

An amount in one currency.

PropertyTypeDetails
AmountWhole numberThe amount in the smallest unit of the currency, for example cents: 1000 is 10.00.
CurrencyTextThe currency, for example eur.

Stripe event​

Everything Stripe sent about one event.

PropertyTypeDetails
Event IDIDThe ID of this event, starting with evt_. May be empty.
Event typeTextThe Stripe event type, for example checkout.session.completed. May be empty.
Live modeYes/NoTrue for real payments, false for test mode. May be empty.
API versionTextThe Stripe API version of the event. May be empty.
Object IDIDThe 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.

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.

Need more help?
Can't find what you're looking for? Our team is happy to help.