Interface APIWebhook

See

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

interface APIWebhook {
    application_id: null | string;
    avatar: null | string;
    channel_id: string;
    guild_id?: string;
    id: string;
    name: null | string;
    source_channel?: Required<
        _NonNullableFields<Pick<APIPartialChannel, "id" | "name">>,
    >;
    source_guild?: APIWebhookSourceGuild;
    token?: string;
    type: WebhookType;
    url?: string;
    user?: APIUser;
}

Properties

application_id avatar channel_id guild_id? id name source_channel? source_guild? token? type url? user?

Properties

application_id

application_id: null | string

The bot/OAuth2 application that created this webhook

avatar

avatar: null | string

The default avatar of the webhook

channel_id

channel_id: string

The channel id this webhook is for

Optionalguild_id

guild_id?: string

The guild id this webhook is for

id

id: string

The id of the webhook

name

name: null | string

The default name of the webhook

Optionalsource_channel

source_channel?: Required<
    _NonNullableFields<Pick<APIPartialChannel, "id" | "name">>,
>

The channel that this webhook is following (returned for Channel Follower Webhooks)

Optionalsource_guild

source_guild?: APIWebhookSourceGuild

The guild of the channel that this webhook is following (returned for Channel Follower Webhooks)

Optionaltoken

token?: string

The secure token of the webhook (returned for Incoming Webhooks)

type

type: WebhookType

The type of the webhook

See

https://discord.com/developers/docs/resources/webhook#webhook-object-webhook-types

Optionalurl

url?: string

The url used for executing the webhook (returned by the webhooks OAuth2 flow)

Optionaluser

user?: APIUser

The user this webhook was created by (not returned when getting a webhook with its token)

See

https://discord.com/developers/docs/resources/user#user-object

Settings

Member Visibility

On This Page

Properties