Class

Webhook

Incoming webhook. Token is only present after create / `fromToken`; fetched webhooks use bot auth and cannot execute.

Extends Base

Constructor1 Properties8 Methods11 Source

Constructor

new Webhook(client: Client, data: APIWebhook & { token?: string | null })

Param	Type	Description
client	`Client`
data	`APIWebhook & { token?: string \| null }`

Properties

avatar: string | null

Webhook avatar hash (null = default).

channelId: string

Channel this webhook posts to.

client: Client (readonly)

Parent client instance.

guildId: string (readonly)

Guild this webhook belongs to.

id: string (readonly)

Webhook snowflake ID.

name: string

Webhook name.

token: string | null (readonly)

Present after create / `fromToken`; omitted when fetching by ID.

user: User (readonly)

The user that created this webhook.

Methods

avatarURL(options?: { size?: number; extension?: string; }): string | null

Param	Type	Description
options?	`{ size?: number; extension?: string; }`

delete(): Promise<void>

Delete this webhook (token auth when available, otherwise bot auth).

deleteMessage(messageId: string): Promise<void>

Delete a message sent by this webhook. Requires token.

Param	Type	Description
messageId	`string`

edit(options: WebhookEditOptions): Promise<this>

Edit name/avatar. With bot auth (no token), `channelId` may also be set.

Param	Type	Description
options	`WebhookEditOptions`

editMessage(messageId: string, options: WebhookMessageEditOptions): Promise<Message>

Edit a message previously sent by this webhook. Requires token.

Param	Type	Description
messageId	`string`
options	`WebhookMessageEditOptions`

fetch(client: Client, webhookId: string): Promise<Webhook>

Fetch a webhook by ID (bot auth; no token).

Param	Type	Description
client	`Client`
webhookId	`string`

fetchMessage(messageId: string): Promise<Message>

Fetch a message sent by this webhook. Requires token.

Param	Type	Description
messageId	`string`

fromToken

(client: Client, webhookId: string, token: string, options?: { channelId?: string; guildId?: string; name?: string; }): Webhook

Build a webhook from a stored id + token (e.g. webhook URL).

Param	Type	Description
client	`Client`
webhookId	`string`
token	`string`
options?	`{ channelId?: string; guildId?: string; name?: string; }`

messageRoute(messageId: string): string

Param	Type	Description
messageId	`string`

requireToken(): string

send(options: string | WebhookSendOptions, wait: boolean): Promise<Message | undefined>

Execute the webhook. Requires token.

Param	Type	Description
options	`string \| WebhookSendOptions`
wait	`boolean`	When true, appends `?wait=true` and returns the created `Message`.