Interface ExecuteWebhookOptions

interface ExecuteWebhookOptions {
    allowedMentions?: AllowedMentions;
    attachments?: MessageAttachment[];
    avatarURL?: string;
    components?: MessageActionRow[];
    content?: string;
    embeds?: EmbedOptions[];
    files?: File[];
    flags?: number;
    poll?: MessagePollOptions;
    threadID?: string;
    threadName?: string;
    tts?: boolean;
    username?: string;
    wait?: boolean;
}

Hierarchy

  • Pick<CreateMessageOptions, "content" | "tts" | "embeds" | "allowedMentions" | "components" | "attachments" | "flags" | "files" | "poll">
    • ExecuteWebhookOptions

Properties

allowedMentions? attachments? avatarURL? components? content? embeds? files? flags? poll? threadID? threadName? tts? username? wait?

Properties

Optional allowedMentions

allowedMentions?: AllowedMentions

An object that specifies the allowed mentions in this message.

Optional attachments

attachments?: MessageAttachment[]

An array of partial attachments related to the sent files.

Optional avatarURL

avatarURL?: string

The url of an avatar to use.

Optional components

components?: MessageActionRow[]

An array of components to send. snake_case keys should be converted to camelCase, or passed through Util#rawMessageComponents.

Optional content

content?: string

The content of the message.

Optional embeds

embeds?: EmbedOptions[]

An array of embeds to send. snake_case keys should be converted to camelCase, or passed through Util#rawEmbeds.

Optional files

files?: File[]

The files to send.

Optional flags

flags?: number

The flags to send with the message.

Optional poll

poll?: MessagePollOptions

A poll to send.

Note

As of 3/22/24:

  • content, components, and many other fields cannot be sent alongside a poll.
    • This means we cannot set allowedMentions. If in the future content can be sent alongside a poll, allowedMentions will not be set automatically, and must be set manually.
  • Messages with a poll cannot be edited.

Optional threadID

threadID?: string

The id of the thread to send the message to.

Optional threadName

threadName?: string

The name of the thread to create (forum channels).

Optional tts

tts?: boolean

If the message should be spoken aloud.

Optional username

username?: string

The username to use.

Optional wait

wait?: boolean

If the created message should be returned.

Settings

Member Visibility

Theme

On This Page