Class Webhook

Represents a webhook.

Hierarchy

Base
- Webhook

Index

Constructors

Constructors

constructor

new Webhook(data, client): Webhook
Parameters
- data: RawWebhook
- client: Client<ClientEvents>
Returns Webhook
Overrides Base.constructor
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:39

Properties

`Private` `Optional` _cachedChannel

_cachedChannel?: any

`Private` `Optional` _cachedGuild

_cachedGuild?: any

`Optional` application

application?: null | ClientApplication

The application associated with this webhook.

applicationID

applicationID: null | string

The ID of the application associated with this webhook.

avatar

avatar: null | string

The hash of this webhook's avatar.

channelID

channelID: null | string

The ID of the channel this webhook is for, if applicable.

client

client: Client<ClientEvents>

guildID

guildID: null | string

The id of the guild this webhook is in, if applicable.

id

id: string

name

name: null | string

The username of this webhook, if any.

`Optional` sourceChannel

sourceChannel?: Pick<RawChannel, "name" | "id">

The source channel for this webhook (channel follower only).

`Optional` sourceGuild

sourceGuild?: Pick<RawGuild, "name" | "id" | "icon">

The source guild for this webhook (channel follower only).

`Optional` token

token?: string

The token for this webhook (not present for webhooks created by other applications)

type

type: WebhookTypes

The type of this webhook.

user

user: null | User

The user that created this webhook.

Accessors

channel

get channel(): undefined | null | AnyTextableGuildChannel
The channel this webhook is for, if applicable.

Returns undefined | null | AnyTextableGuildChannel
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:41

createdAt

get createdAt(): Date
Returns Date
Inherited from Base.createdAt
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:15

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
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:43

url

get url(): string
Returns string
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:44

Methods

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
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:50

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>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:55

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>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:62

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>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:67

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>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:72

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>>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:80

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>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:86

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>>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:92
execute(options, token?): Promise<void>
Parameters
- options: ExecuteWebhookOptions
- Optional token: string
Returns Promise<void>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:93

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>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:99
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>>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:102

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>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:110
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>>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:113

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>>
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:122

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
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:128

toJSON

toJSON(): JSONWebhook
Returns JSONWebhook
Overrides Base.toJSON
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Webhook.d.ts:129

toString

toString(): string
Returns string
Inherited from Base.toString
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:19

`Protected` update

update(data): void
Parameters
- data: unknown
Returns void
Inherited from Base.update
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:14

`Static` generateID

generateID(timestamp?): string
Parameters
- Optional timestamp: number | Date
Returns string
Inherited from Base.generateID
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:11

`Static` getCreatedAt

getCreatedAt(id): Date
Parameters
- id: string
Returns Date
Inherited from Base.getCreatedAt
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:12

`Static` getDiscordEpoch

getDiscordEpoch(id): number
Parameters
- id: string
Returns number
Inherited from Base.getDiscordEpoch
- Defined in node_modules/.pnpm/oceanic.js@1.7.1/node_modules/oceanic.js/dist/lib/structures/Base.d.ts:13

Class Webhook

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: RawWebhook

client: Client<ClientEvents>

Returns Webhook

Properties

Private Optional _cachedChannel

Private Optional _cachedGuild

Optional application

applicationID

avatar

channelID

client

guildID

id

name

Optional sourceChannel

Optional sourceGuild

Optional token

type

user

Accessors

channel

Returns undefined | null | AnyTextableGuildChannel

createdAt

Returns Date

guild

Returns null | Guild

url

Returns string

Methods

avatarURL

Parameters

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

Optional size: number

Returns null | string

delete

Parameters

Optional reason: string

Returns Promise<void>

deleteMessage

Parameters

messageID: string

Optional options: DeleteWebhookMessageOptions

Optional token: string

Returns Promise<void>

deleteToken

Parameters

Optional token: string

Returns Promise<void>

edit

Parameters

options: EditWebhookOptions

Returns Promise<Webhook>

editMessage

Type Parameters

T extends AnyTextableGuildChannel = AnyTextableGuildChannel

Parameters

messageID: string

options: EditWebhookMessageOptions

Optional token: string

Returns Promise<Message<T>>

editToken

Parameters

options: EditWebhookOptions

Optional token: string

Returns Promise<Webhook>

execute

Type Parameters

T extends AnyTextableGuildChannel

Parameters

options: ExecuteWebhookWaitOptions

`Private` `Optional` _cachedChannel

`Private` `Optional` _cachedGuild

`Optional` application

`Optional` sourceChannel

`Optional` sourceGuild

`Optional` token

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

`Optional` size: number

`Optional` reason: string

`Optional` options: DeleteWebhookMessageOptions

`Optional` token: string

`Optional` token: string

`Optional` token: string

`Optional` token: string

`Optional` token: string

`Optional` token: string

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

`Optional` token: string

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

`Optional` token: string

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

`Optional` token: string

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

`Optional` token: string

`Optional` threadID: string

`Optional` token: string

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

`Optional` size: number

`Protected` update

`Static` generateID

`Optional` timestamp: number | Date

`Static` getCreatedAt

`Static` getDiscordEpoch