Type alias ChatEmbedPayload

ChatEmbedPayload: {
    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;
}

Rich content sections optionally associated with chat messages. Properties with "webhook-markdown" support allow for the following: link, italic, bold, strikethrough, underline, inline code, block code, reaction, mention, and role mention.

Type declaration

  • Optional author?: {
        icon_url?: string;
        name?: string;
        url?: string;
    }

    A small section above the title of the embed

    • Optional icon_url?: string

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

    • Optional name?: string

      Name of the author

    • Optional url?: string

      URL to linkify the author's name field

  • Optional color?: number

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

  • Optional description?: string

    Subtext of the embed

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

    Table-like cells to add to the embed

  • Optional footer?: {
        icon_url?: string;
        text: string;
    }

    A small section at the bottom of the embed

    • Optional icon_url?: string

      URL of a small image to put in the footer

    • text: string

      Text of the footer

  • Optional image?: {
        url?: string;
    }

    The main picture to associate with the embed

    • Optional url?: string

      URL of the image

  • Optional thumbnail?: {
        url?: string;
    }

    An image to the right of the embed's content

    • Optional url?: string

      URL of the image

  • Optional timestamp?: string

    A timestamp to put in the footer

  • Optional title?: string

    Main header of the embed

  • Optional url?: string

    URL to linkify the title field with

Generated using TypeDoc