Class Webhook

constructor

• new Webhook(data, client): Webhook

• Parameters

  • data: RawWebhook

  • client: Client<ClientEvents>

  Returns Webhook

Optional application

applicationID

avatar

channelID

guildID

name

Optional sourceChannel

Optional sourceGuild

Optional token

type

user

channel

• get channel(): undefined | null | AnyTextableGuildChannel

• The channel this webhook is for, if applicable.

  Returns undefined | null | AnyTextableGuildChannel

guild

• get guild(): null | Guild

• The guild this webhook is for, if applicable. This will throw an error if the guild is not cached.

  Returns null | Guild

url

• get url(): string

• Returns string

avatarURL

• avatarURL(format?, size?): null | string

• The url of this webhook's avatar.

  Parameters

  • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

    The format the url should be.

  • Optional size: number

    The dimensions of the image.

  Returns null | string

delete

• delete(reason?): Promise<void>

• Delete this webhook (requires a bot user, see deleteToken).

  Parameters

  • Optional reason: string

    The reason for deleting this webhook.

  Returns Promise<void>

deleteMessage

• deleteMessage(messageID, options?, token?): Promise<void>

• Delete a message from this webhook.

  Parameters

  • messageID: string

    The ID of the message.

  • Optional options: DeleteWebhookMessageOptions

    The options for deleting the message.

  • Optional token: string

    The token for the webhook, if not already present.

  Returns Promise<void>

deleteToken

• deleteToken(token?): Promise<void>

• Delete this webhook via its token.

  Parameters

  • Optional token: string

    The token for the webhook, if not already present.

  Returns Promise<void>

edit

• edit(options): Promise<Webhook>

• Edit this webhook (requires a bot user, see editToken).

  Parameters

  • options: EditWebhookOptions

    The options for editing the webhook.

  Returns Promise<Webhook>

editMessage

• editMessage<T>(messageID, options, token?): Promise<Message<T>>

• Edit a webhook message.

  Type Parameters

  • T extends AnyTextableGuildChannel = AnyTextableGuildChannel

  Parameters

  • messageID: string

    The ID of the message to edit.

  • options: EditWebhookMessageOptions

    The options for editing the message.

  • Optional token: string

    The token of the webhook.

  Returns Promise<Message<T>>

editToken

• editToken(options, token?): Promise<Webhook>

• Edit a webhook via its token.

  Parameters

  • options: EditWebhookOptions

    The options for editing the webhook.

  • Optional token: string

    The token for the webhook, if not already present.

  Returns Promise<Webhook>

execute

• execute<T>(options, token?): Promise<Message<T>>

• Execute the webhook.

  Type Parameters

  • T extends AnyTextableGuildChannel

  Parameters

  • options: ExecuteWebhookWaitOptions

    The options for executing the webhook.

  • Optional token: string

    The token for the webhook, if not already present.

  Returns Promise<Message<T>>
• execute(options, token?): Promise<void>

• Parameters

  • options: ExecuteWebhookOptions

  • Optional token: string

  Returns Promise<void>

executeGithub

• executeGithub(options, token?): Promise<void>

• Execute this webhook as GitHub compatible.

  Parameters

  • options: Record<string, unknown> & {
        wait: false;
    }

    The options to send. See GitHub's documentation for more information.

  • Optional token: string

    The token for the webhook, if not already present.

  Returns Promise<void>
• executeGithub<T>(options, token?): Promise<Message<T>>

• Type Parameters

  • T extends AnyTextableGuildChannel

  Parameters

  • options: Record<string, unknown> & {
        wait?: true;
    }

  • Optional token: string

  Returns Promise<Message<T>>

executeSlack

• executeSlack(options, token?): Promise<void>

• Execute this webhook as slack compatible.

  Parameters

  • options: Record<string, unknown> & {
        wait: false;
    }

    The options to send. See Slack's Documentation for more information.

  • Optional token: string

    The token for the webhook, if not already present.

  Returns Promise<void>
• executeSlack<T>(options, token?): Promise<Message<T>>

• Type Parameters

  • T extends AnyTextableGuildChannel

  Parameters

  • options: Record<string, unknown> & {
        wait?: true;
    }

  • Optional token: string

  Returns Promise<Message<T>>

getMessage

• getMessage<T>(messageID, threadID?, token?): Promise<Message<T>>

• Get a webhook message.

  Type Parameters

  • T extends AnyTextableGuildChannel

  Parameters

  • messageID: string

    The ID of the message.

  • Optional threadID: string

    The ID of the thread the message is in.

  • Optional token: string

    The token for the webhook, if not already present.

  Returns Promise<Message<T>>

sourceGuildIconURL

• sourceGuildIconURL(format?, size?): null | string

• The url of this webhook's sourceGuild icon (only present on channel follower webhooks).

  Parameters

  • Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"

    The format the url should be.

  • Optional size: number

    The dimensions of the image.

  Returns null | string

toJSON

• toJSON(): JSONWebhook

• Returns JSONWebhook