Class Webhook

Represents a Discord webhook.

Hierarchy

DiscordBase
ObjectToLower<Omit<APIWebhook, "user" | "source_guild">>
- Webhook

Index

Constructors

constructor

new Webhook(client: UsingClient, data: APIWebhook): Webhook
Constructs a new Webhook instance.
Parameters
- client: UsingClient
  The Discord client instance.
- data: APIWebhook
  The data representing the webhook.
Returns Webhook
Inherited from DiscordBase.constructor
- Defined in src/structures/Webhook.ts:49

Properties

applicationId

applicationId: null | string

avatar

avatar: null | string

channelId

channelId: string

`Readonly`client

client: UsingClient

`Optional`guildId

guildId?: string

id

id: string

messages

messages: {
    delete: (messageId: string, reason?: string) => Promise<undefined>;
    edit: (
        payload: {
            body: Omit<
                RESTPatchAPIWebhookWithTokenMessageJSONBody,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & ResolverProps;
            messageId: string;
            query?: RESTPatchAPIWebhookWithTokenMessageQuery;
        },
    ) => Promise<WebhookMessage>;
    write: (
        payload: {
            body: Omit<
                RESTPostAPIWebhookWithTokenJSONBody,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & SendResolverProps;
            query?: RESTPostAPIWebhookWithTokenQuery;
        },
    ) => Promise<null | WebhookMessage>;
}

Methods related to interacting with messages through the webhook.

Type declaration

delete: (messageId: string, reason?: string) => Promise<undefined>
Deletes a message sent through the webhook.
edit: (
    payload: {
        body: Omit<
            RESTPatchAPIWebhookWithTokenMessageJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & ResolverProps;
        messageId: string;
        query?: RESTPatchAPIWebhookWithTokenMessageQuery;
    },
) => Promise<WebhookMessage>
Edits a message sent through the webhook.
write: (
    payload: {
        body: Omit<
            RESTPostAPIWebhookWithTokenJSONBody,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps;
        query?: RESTPostAPIWebhookWithTokenQuery;
    },
) => Promise<null | WebhookMessage>
Writes a message through the webhook.

name

name: null | string

`Optional`sourceChannel

sourceChannel?: { id: string; name?: null | string; type: ChannelType }

`Optional`sourceGuild

sourceGuild?: Partial<AnonymousGuild>

The source guild of the webhook, if applicable.

`Optional`token

token?: string

type

type: WebhookType

`Optional`url

url?: string

`Optional`user

user?: User

The user associated with the webhook, if applicable.

Accessors

createdAt

get createdAt(): Date
createdAt gets the creation Date instace of the current object.

Returns Date
Inherited from DiscordBase.createdAt
- Defined in src/structures/extra/DiscordBase.ts:27

createdTimestamp

get createdTimestamp(): number
Create a timestamp for the current object.

Returns number
Inherited from DiscordBase.createdTimestamp
- Defined in src/structures/extra/DiscordBase.ts:20

Methods

avatarURL

avatarURL(options?: CDNUrlOptions): null | string
Retrieves the avatar URL of the webhook.
Parameters
- Optionaloptions: CDNUrlOptions
  The image options for the avatar.
Returns null | string
The avatar URL of the webhook, or null if no avatar is set.
- Defined in src/structures/Webhook.ts:110

channel

channel(mode?: "rest" | "flow"): Promise<AllChannels>
Fetches the channel associated with the webhook.
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<AllChannels>
A promise that resolves to the channel associated with the webhook, or undefined if not applicable.
- Defined in src/structures/Webhook.ts:91
channel(mode: "cache"): ReturnCache<undefined | AllChannels>
Fetches the channel associated with the webhook.
Parameters
- mode: "cache"
Returns ReturnCache<undefined | AllChannels>
A promise that resolves to the channel associated with the webhook, or undefined if not applicable.
- Defined in src/structures/Webhook.ts:92

delete

delete(reason?: string): Promise<undefined>
Deletes the webhook.
Parameters
- Optionalreason: string
  The reason for deleting the webhook.
Returns Promise<undefined>
A promise that resolves when the webhook is successfully deleted.
- Defined in src/structures/Webhook.ts:144

edit

edit(
body: RESTPatchAPIWebhookJSONBody | RESTPatchAPIWebhookWithTokenJSONBody,
reason?: string,
): Promise<Webhook>
Edits the webhook.
Parameters
- body: RESTPatchAPIWebhookJSONBody | RESTPatchAPIWebhookWithTokenJSONBody
  The new webhook data.
- Optionalreason: string
  The reason for editing the webhook.
Returns Promise<Webhook>
A promise that resolves when the webhook is successfully edited.
- Defined in src/structures/Webhook.ts:132

fetch

fetch(): Promise<Webhook>
Fetches the webhook data from the Discord API.

Returns Promise<Webhook>
A promise that resolves to the fetched webhook data.
- Defined in src/structures/Webhook.ts:122

guild

guild(mode?: "rest" | "flow"): Promise<undefined | Guild<"cached" | "api">>
Fetches the guild associated with the webhook.
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<undefined | Guild<"cached" | "api">>
A promise that resolves to the guild associated with the webhook, or undefined if not applicable.
- Defined in src/structures/Webhook.ts:70
guild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>
Fetches the guild associated with the webhook.
Parameters
- mode: "cache"
Returns ReturnCache<undefined | Guild<"cached">>
A promise that resolves to the guild associated with the webhook, or undefined if not applicable.
- Defined in src/structures/Webhook.ts:71

`Static`messages

messages(
    __namedParameters: {
        client: UsingClient;
        webhookId: string;
        webhookToken: string;
    },
): {
    delete: (messageId: string, reason?: string) => Promise<undefined>;
    edit: (
        payload: {
            body: Omit<
                RESTPatchAPIWebhookWithTokenMessageJSONBody,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & ResolverProps;
            messageId: string;
            query?: RESTPatchAPIWebhookWithTokenMessageQuery;
        },
    ) => Promise<WebhookMessage>;
    write: (
        payload: {
            body: Omit<
                RESTPostAPIWebhookWithTokenJSONBody,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & SendResolverProps;
            query?: RESTPostAPIWebhookWithTokenQuery;
        },
    ) => Promise<null | WebhookMessage>;
}
Static methods related to interacting with messages through webhooks.
Parameters
- __namedParameters: { client: UsingClient; webhookId: string; webhookToken: string }
Returns {
    delete: (messageId: string, reason?: string) => Promise<undefined>;
    edit: (
        payload: {
            body: Omit<
                RESTPatchAPIWebhookWithTokenMessageJSONBody,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & ResolverProps;
            messageId: string;
            query?: RESTPatchAPIWebhookWithTokenMessageQuery;
        },
    ) => Promise<WebhookMessage>;
    write: (
        payload: {
            body: Omit<
                RESTPostAPIWebhookWithTokenJSONBody,
                "components"
                | "content"
                | "embeds"
                | "poll",
            > & SendResolverProps;
            query?: RESTPostAPIWebhookWithTokenQuery;
        },
    ) => Promise<null | WebhookMessage>;
}
- delete: (messageId: string, reason?: string) => Promise<undefined>
  Deletes a message sent through the webhook.
- edit: (
      payload: {
          body: Omit<
              RESTPatchAPIWebhookWithTokenMessageJSONBody,
              "components"
              | "content"
              | "embeds"
              | "poll",
          > & ResolverProps;
          messageId: string;
          query?: RESTPatchAPIWebhookWithTokenMessageQuery;
      },
  ) => Promise<WebhookMessage>
  Edits a message sent through the webhook.
- write: (
      payload: {
          body: Omit<
              RESTPostAPIWebhookWithTokenJSONBody,
              "components"
              | "content"
              | "embeds"
              | "poll",
          > & SendResolverProps;
          query?: RESTPostAPIWebhookWithTokenQuery;
      },
  ) => Promise<null | WebhookMessage>
  Writes a message through the webhook.
- Defined in src/structures/Webhook.ts:151

`Static`methods

methods(
    __namedParameters: {
        client: UsingClient;
        webhookId: string;
        webhookToken?: string;
    },
): {
    delete: (reason?: string) => Promise<undefined>;
    edit: (
        body:
            | RESTPatchAPIWebhookJSONBody
            | RESTPatchAPIWebhookWithTokenJSONBody,
        reason?: string,
    ) => Promise<Webhook>;
    fetch: () => Promise<Webhook>;
}
Static methods related to managing webhooks.
Parameters
- __namedParameters: { client: UsingClient; webhookId: string; webhookToken?: string }
Returns {
    delete: (reason?: string) => Promise<undefined>;
    edit: (
        body:
            | RESTPatchAPIWebhookJSONBody
            | RESTPatchAPIWebhookWithTokenJSONBody,
        reason?: string,
    ) => Promise<Webhook>;
    fetch: () => Promise<Webhook>;
}
- delete: (reason?: string) => Promise<undefined>
  Deletes the webhook.
- edit: (
  body: RESTPatchAPIWebhookJSONBody | RESTPatchAPIWebhookWithTokenJSONBody,
  reason?: string,
  ) => Promise<Webhook>
  Edits the webhook.
- fetch: () => Promise<Webhook>
  Fetches the webhook data from the Discord API.
- Defined in src/structures/Webhook.ts:168

Class Webhook

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Webhook

Properties

applicationId

avatar

channelId

Readonlyclient

OptionalguildId

id

messages

Type declaration

delete: (messageId: string, reason?: string) => Promise<undefined>

edit: ( payload: { body: Omit< RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "content" | "embeds" | "poll", > & ResolverProps; messageId: string; query?: RESTPatchAPIWebhookWithTokenMessageQuery; },) => Promise<WebhookMessage>

write: ( payload: { body: Omit< RESTPostAPIWebhookWithTokenJSONBody, "components" | "content" | "embeds" | "poll", > & SendResolverProps; query?: RESTPostAPIWebhookWithTokenQuery; },) => Promise<null | WebhookMessage>

name

OptionalsourceChannel

OptionalsourceGuild

Optionaltoken

type

Optionalurl

Optionaluser

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

Methods

avatarURL

Parameters

Returns null | string

channel

Parameters

Returns Promise<AllChannels>

Parameters

Returns ReturnCache<undefined | AllChannels>

delete

Parameters

Returns Promise<undefined>

edit

Parameters

Returns Promise<Webhook>

fetch

Returns Promise<Webhook>

guild

Parameters

Returns Promise<undefined | Guild<"cached" | "api">>

Parameters

Returns ReturnCache<undefined | Guild<"cached">>

Staticmessages

Parameters

delete: (messageId: string, reason?: string) => Promise<undefined>

edit: ( payload: { body: Omit< RESTPatchAPIWebhookWithTokenMessageJSONBody, "components" | "content" | "embeds" | "poll", > & ResolverProps; messageId: string; query?: RESTPatchAPIWebhookWithTokenMessageQuery; },) => Promise<WebhookMessage>

write: ( payload: { body: Omit< RESTPostAPIWebhookWithTokenJSONBody, "components" | "content" | "embeds" | "poll", > & SendResolverProps; query?: RESTPostAPIWebhookWithTokenQuery; },) => Promise<null | WebhookMessage>

Staticmethods

Parameters

Returns { delete: (reason?: string) => Promise<undefined>; edit: ( body: | RESTPatchAPIWebhookJSONBody | RESTPatchAPIWebhookWithTokenJSONBody, reason?: string, ) => Promise<Webhook>; fetch: () => Promise<Webhook>;}

delete: (reason?: string) => Promise<undefined>

edit: ( body: RESTPatchAPIWebhookJSONBody | RESTPatchAPIWebhookWithTokenJSONBody, reason?: string,) => Promise<Webhook>

fetch: () => Promise<Webhook>

Settings

On This Page

`Readonly`client

`Optional`guildId

edit: (
payload: {
body: Omit<
RESTPatchAPIWebhookWithTokenMessageJSONBody,
"components"
| "content"
| "embeds"
| "poll",
> & ResolverProps;
messageId: string;
query?: RESTPatchAPIWebhookWithTokenMessageQuery;
},
) => Promise<WebhookMessage>

write: (
payload: {
body: Omit<
RESTPostAPIWebhookWithTokenJSONBody,
"components"
| "content"
| "embeds"
| "poll",
> & SendResolverProps;
query?: RESTPostAPIWebhookWithTokenQuery;
},
) => Promise<null | WebhookMessage>

`Optional`sourceChannel

`Optional`sourceGuild

`Optional`token

`Optional`url

`Optional`user

`Static`messages

edit: (
payload: {
body: Omit<
RESTPatchAPIWebhookWithTokenMessageJSONBody,
"components"
| "content"
| "embeds"
| "poll",
> & ResolverProps;
messageId: string;
query?: RESTPatchAPIWebhookWithTokenMessageQuery;
},
) => Promise<WebhookMessage>

write: (
payload: {
body: Omit<
RESTPostAPIWebhookWithTokenJSONBody,
"components"
| "content"
| "embeds"
| "poll",
> & SendResolverProps;
query?: RESTPostAPIWebhookWithTokenQuery;
},
) => Promise<null | WebhookMessage>

`Static`methods

Returns {
delete: (reason?: string) => Promise<undefined>;
edit: (
body:
| RESTPatchAPIWebhookJSONBody
| RESTPatchAPIWebhookWithTokenJSONBody,
reason?: string,
) => Promise<Webhook>;
fetch: () => Promise<Webhook>;
}

edit: (
body: RESTPatchAPIWebhookJSONBody | RESTPatchAPIWebhookWithTokenJSONBody,
reason?: string,
) => Promise<Webhook>