Interface POSTExecuteWebhookBody

interface POSTExecuteWebhookBody {
    avatar_url?: string;
    content?: string;
    embeds?: {
        author?: {
            icon_url?: string;
            name?: string;
            url?: string;
        };
        color?: number;
        description?: string;
        fields?: {
            inline: boolean;
            name: string;
            value: string;
        }[];
        footer?: {
            icon_url?: string;
            text: string;
        };
        image?: {
            url?: string;
        };
        thumbnail?: {
            url?: string;
        };
        timestamp?: string;
        title?: string;
        url?: string;
    }[];
    username?: string;
}

Properties

avatar_url? content? embeds? username?

Properties

Optionalavatar_url

avatar_url?: string

Optionalcontent

content?: string

Optionalembeds

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

Type declaration

  • Optionalauthor?: {
        icon_url?: string;
        name?: string;
        url?: string;
    }

    Description

    A small section above the title of the embed

    • Optionalicon_url?: string

      Format: media-uri

      Description

      URL of a small image to display to the left of the author's name

    • Optionalname?: string

      Description

      Name of the author

    • Optionalurl?: string

      Format: uri

      Description

      URL to linkify the author's name field

  • Optionalcolor?: number

    Description

    The integer value corresponds to the decimal RGB representation for the color. The color that the left border should be

  • Optionaldescription?: string

    Format: webhook-markdown

    Description

    Subtext of the embed

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

    Description

    Table-like cells to add to the embed

  • Optionalfooter?: {
        icon_url?: string;
        text: string;
    }

    Description

    A small section at the bottom of the embed

    • Optionalicon_url?: string

      Format: media-uri

      Description

      URL of a small image to put in the footer

    • text: string

      Description

      Text of the footer

  • Optionalimage?: {
        url?: string;
    }

    Description

    The main picture to associate with the embed

    • Optionalurl?: string

      Format: media-uri

      Description

      URL of the image

  • Optionalthumbnail?: {
        url?: string;
    }

    Description

    An image to the right of the embed's content

    • Optionalurl?: string

      Format: media-uri

      Description

      URL of the image

  • Optionaltimestamp?: string

    Format: date-time

    Description

    A timestamp to put in the footer

  • Optionaltitle?: string

    Format: webhook-markdown

    Description

    Main header of the embed

  • Optionalurl?: string

    Format: uri

    Description

    URL to linkify the title field with

Optionalusername

username?: string

Settings

Member Visibility

On This Page

Properties