Skip to main content

ExecuteWebhook

Documentation

Documentation / @discordeno/types / ExecuteWebhook

Interface: ExecuteWebhook

Defined in: discordeno/webhook.ts:29

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

Properties​

allowedMentions?​

optional allowedMentions?: AllowedMentions

Defined in: discordeno/webhook.ts:57

Allowed mentions for the message

appliedTags?​

optional appliedTags?: BigString[]

Defined in: discordeno/webhook.ts:79

Array of tag ids to apply to the thread (requires the webhook channel to be a forum or media channel)

attachments?​

optional attachments?: Pick<DiscordAttachment, "id" | "description" | "filename">[]

Defined in: discordeno/webhook.ts:69

Attachment objects with filename and description

avatarUrl?​

optional avatarUrl?: string

Defined in: discordeno/webhook.ts:51

Override the default avatar of the webhook

components?​

optional components?: MessageComponents

Defined in: discordeno/webhook.ts:65

The components to include with the message

Remarks​

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.

content?​

optional content?: string

Defined in: discordeno/webhook.ts:47

The message contents (up to 2000 characters)

embeds?​

optional embeds?: object[]

Defined in: discordeno/webhook.ts:55

Embedded rich content

author?​

optional author?: object

author.iconUrl?​

optional iconUrl?: string

author.name​

name: string

author.proxyIconUrl?​

optional proxyIconUrl?: string

author.url?​

optional url?: string

color?​

optional color?: number

description?​

optional description?: string

fields?​

optional fields?: object[]

optional footer?: object

footer.iconUrl?​

optional iconUrl?: string

footer.proxyIconUrl?​

optional proxyIconUrl?: string

footer.text​

text: string

image?​

optional image?: object

image.height?​

optional height?: number

image.proxyUrl?​

optional proxyUrl?: string

image.url​

url: string

image.width?​

optional width?: number

provider?​

optional provider?: object

provider.name?​

optional name?: string

provider.url?​

optional url?: string

thumbnail?​

optional thumbnail?: object

thumbnail.height?​

optional height?: number

thumbnail.proxyUrl?​

optional proxyUrl?: string

thumbnail.url​

url: string

thumbnail.width?​

optional width?: number

timestamp?​

optional timestamp?: string

title?​

optional title?: string

type?​

optional type?: EmbedTypes

url?​

optional url?: string

video?​

optional video?: object

video.height?​

optional height?: number

video.proxyUrl?​

optional proxyUrl?: string

video.url?​

optional url?: string

video.width?​

optional width?: number

files?​

optional files?: FileContent[]

Defined in: discordeno/webhook.ts:67

The contents of the files being sent

flags?​

optional flags?: number

Defined in: discordeno/webhook.ts:75

Message flags combined in a bitfield

See​

MessageFlags

poll?​

optional poll?: CreatePoll

Defined in: discordeno/webhook.ts:81

A poll object

threadId?​

optional threadId?: BigString

Defined in: discordeno/webhook.ts:35

Send a message to the specified thread within a webhook's channel. The thread will automatically be unarchived.

threadName?​

optional threadName?: string

Defined in: discordeno/webhook.ts:77

Name of the thread to create (target channel has to be type of forum channel)

tts?​

optional tts?: boolean

Defined in: discordeno/webhook.ts:53

True if this is a TTS message

username?​

optional username?: string

Defined in: discordeno/webhook.ts:49

Override the default username of the webhook

wait?​

optional wait?: boolean

Defined in: discordeno/webhook.ts:33

Waits for server confirmation of message send before response, and returns the created message body (defaults to false; when false a message that is not saved does not return an error)

withComponents?​

optional withComponents?: boolean

Defined in: discordeno/webhook.ts:42

Whether to respect the components field of the request. When enabled, allows application-owned webhooks to use all components and non-owned webhooks to use non-interactive components.

Default​

false