Preview environment

interface APIWebhook

export interface APIWebhook

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

application_id : Snowflake | null

The bot/OAuth2 application that created this webhook

avatar : string | null

The default avatar of the webhook

channel_id : Snowflake

The channel id this webhook is for

optional
guild_id? : Snowflake

The guild id this webhook is for

id : Snowflake

The id of the webhook

name : string | null

The default name of the webhook

optional
source_channel? : APIPartialChannel

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

optional
source_guild? : APIPartialGuild

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

optional
token? : string

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

type : WebhookType

The type of the webhook

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

optional
url? : string

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

optional
user? : APIUser

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

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