Skip to main content

EditWebhookMessageOptions

Documentation


Documentation / @discordeno/types / EditWebhookMessageOptions

Interface: EditWebhookMessageOptions

Defined in: discordeno/webhook.ts:91

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

Properties

allowedMentions?

optional allowedMentions?: AllowedMentions

Defined in: discordeno/webhook.ts:116

Allowed mentions for the message


attachments?

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

Defined in: discordeno/webhook.ts:128

Attached files to keep and possible descriptions for new files


components?

optional components?: MessageComponents

Defined in: discordeno/webhook.ts:124

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:106

The message contents (up to 2000 characters)


embeds?

optional embeds?: object[]

Defined in: discordeno/webhook.ts:108

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:126

The contents of the files being sent


flags?

optional flags?: number

Defined in: discordeno/webhook.ts:114

Message flags combined in a bitfield

See

MessageFlags


poll?

optional poll?: CreatePoll

Defined in: discordeno/webhook.ts:135

A poll!

Remarks

Polls can only be added when editing a deferred interaction response.


threadId?

optional threadId?: BigString

Defined in: discordeno/webhook.ts:94

Id of the thread the message is in


withComponents?

optional withComponents?: boolean

Defined in: discordeno/webhook.ts:101

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