Version: Next

APIEmbed

@see: https://discord.com/developers/docs/resources/message#embed-object-embed-structure

Length limit: 6000 characters

Index

Properties

author
color
components
description
fields
flags
footer
image
provider
thumbnail
timestamp
title
type
url
video

Properties

optionalauthor

author?: APIEmbedAuthor

Author information

@see: https://discord.com/developers/docs/resources/message#embed-object-embed-author-structure

optionalcolor

color?: number

Color code of the embed

optionalcomponents

components?: APIComponentEmbedContainer[]

Components that make up the embed, only present on components type embeds.

@see: https://docs.discord.com/developers/link-previews/component-embeds

optionaldescription

description?: string

Description of embed

Length limit: 4096 characters

optionalfields

fields?: APIEmbedField[]

Fields information

Length limit: 25 field objects

@see: https://discord.com/developers/docs/resources/message#embed-object-embed-field-structure

optionalflags

flags?: EmbedFlags

Embed flags combined as a bitfield

@see

optionalfooter

footer?: APIEmbedFooter

Footer information

@see: https://discord.com/developers/docs/resources/message#embed-object-embed-footer-structure

optionalimage

image?: APIEmbedImage

Image information

@see: https://discord.com/developers/docs/resources/message#embed-object-embed-image-structure

optionalprovider

provider?: APIEmbedProvider

Provider information

@see: https://discord.com/developers/docs/resources/message#embed-object-embed-provider-structure

optionalthumbnail

thumbnail?: APIEmbedImage

Thumbnail information

@see: https://docs.discord.com/developers/resources/message#embed-object-embed-image-structure

optionaltimestamp

timestamp?: string

Timestamp of embed content

optionaltitle

title?: string

Title of embed

Length limit: 256 characters

optionaltype

type?: EmbedType

Type of embed (always "rich" for webhook embeds)

optionalurl

url?: string

URL of embed

optionalvideo

video?: APIEmbedVideo

Video information

@see: https://discord.com/developers/docs/resources/message#embed-object-embed-video-structure