Interface RESTPostAPIWebhookWithTokenJSONBody

See

https://discord.com/developers/docs/resources/webhook#execute-webhook

interface RESTPostAPIWebhookWithTokenJSONBody {
    allowed_mentions?: APIAllowedMentions;
    applied_tags?: string[];
    attachments?: RESTAPIAttachment[];
    avatar_url?: string;
    components?: APIMessageTopLevelComponent[];
    content?: string;
    embeds?: APIEmbed[];
    flags?: MessageFlags;
    poll?: RESTAPIPoll;
    thread_name?: string;
    tts?: boolean;
    username?: string;
}

Properties

allowed_mentions? applied_tags? attachments? avatar_url? components? content? embeds? flags? poll? thread_name? tts? username?

Properties

Optionalallowed_mentions

allowed_mentions?: APIAllowedMentions

Allowed mentions for the message

See

https://discord.com/developers/docs/resources/channel#allowed-mentions-object

Optionalapplied_tags

applied_tags?: string[]

Array of tag ids to apply to the thread

Optionalattachments

attachments?: RESTAPIAttachment[]

Attachment objects with filename and description

Optionalavatar_url

avatar_url?: string

Override the default avatar of the webhook

Optionalcomponents

components?: APIMessageTopLevelComponent[]

The components to include with the message

Application-owned webhooks can always send components. Non-application-owned webhooks cannot send interactive components, and the components field will be ignored unless they set the with_components query param.

See

https://discord.com/developers/docs/components/reference

Optionalcontent

content?: string

The message contents (up to 2000 characters)

Optionalembeds

embeds?: APIEmbed[]

Embedded rich content

See

https://discord.com/developers/docs/resources/channel#embed-object

Optionalflags

flags?: MessageFlags

Message flags combined as a bitfield

Optionalpoll

poll?: RESTAPIPoll

A poll!

Optionalthread_name

thread_name?: string

Name of thread to create

Available only if the webhook is in a forum channel and a thread is not specified in RESTPostAPIWebhookWithTokenQuery.thread_id query parameter

Optionaltts

tts?: boolean

true if this is a TTS message

Optionalusername

username?: string

Override the default username of the webhook

Settings

Member Visibility

On This Page

Properties