Interface Embed

interface Embed {
    author?: {
        iconURL?: string;
        name?: string;
        url?: string;
    };
    color?: number;
    description?: string;
    fields?: {
        inline: boolean;
        name: string;
        value: string;
    }[];
    footer?: {
        iconURL?: string;
        text: string;
    };
    image?: {
        url?: string;
    };
    thumbnail?: {
        url?: string;
    };
    timestamp?: string;
    title?: string;
    url?: string;
}

Properties

author? color? description? fields? footer? image? thumbnail? timestamp? title? url?

Properties

Optionalauthor

author?: {
    iconURL?: string;
    name?: string;
    url?: string;
}

A small section above the title of the embed

Type declaration

  • OptionaliconURL?: string

    URL of a small image to display to the left of the author's name (max length 1024)

  • Optionalname?: string

    Name of the author (max length 256)

  • Optionalurl?: string

    URL to linkify the author's name field (max length 1024; regex ^(?!attachment))

Optionalcolor

color?: number

Embed's color, decimal number (base 16),

To convert to HEX use: parseInt("HEX", 16), don't forget to remove the hashtag.

Optionaldescription

description?: string

Subtext of the embed (max length 2048)

Optionalfields

fields?: {
    inline: boolean;
    name: string;
    value: string;
}[]

Table-like cells to add to the embed (max items 25)

Type declaration

  • inline: boolean

    Description

    If the field should wrap or not

    Default

    false
  • name: string

    Format: webhook-markdown

    Description

    Header of the table-like cell

  • value: string

    Format: webhook-markdown

    Description

    Subtext of the table-like cell

Optionalfooter

footer?: {
    iconURL?: string;
    text: string;
}

Type declaration

  • OptionaliconURL?: string

    URL of a small image to put in the footer (max length 1024)

  • text: string

    Text of the footer (max length 2048)

Optionalimage

image?: {
    url?: string;
}

Type declaration

  • Optionalurl?: string

    URL of the image (max length 1024)

Optionalthumbnail

thumbnail?: {
    url?: string;
}

An image to the right of the embed's content

Type declaration

  • Optionalurl?: string

    URL of the image (max length 1024)

Optionaltimestamp

timestamp?: string

A timestamp to put in the footer

Optionaltitle

title?: string

Main header of the embed (max length 256)

Optionalurl

url?: string

URL to linkify the title field with (max length 1024; regex ^(?!attachment))

Settings

Member Visibility

On This Page

Properties