Class Webhooks

Various methods for interacting with webhooks.

Hierarchy

Webhooks

Index

Constructors

Methods

create delete deleteMessage deleteToken edit editMessage editToken execute executeGithub executeSlack get getForChannel getForGuild getMessage

Constructors

constructor

new Webhooks(manager: RESTManager): Webhooks
Parameters
- manager: RESTManager
Returns Webhooks
- Defined in lib/routes/Webhooks.ts:22

Methods

create

create(channelID: string, options: CreateWebhookOptions): Promise<Webhook>
Create a channel webhook.
Parameters
- channelID: string
  
  The ID of the channel to create the webhook in.
- options: CreateWebhookOptions
  
  The options to create the webhook with.
Returns Promise<Webhook>
- Defined in lib/routes/Webhooks.ts:31

delete

delete(webhookID: string, reason?: string): Promise<void>
Delete a webhook.
Parameters
- webhookID: string
  
  The ID of the webhook.
- Optional reason: string
  
  The reason for deleting the webhook.
Returns Promise<void>
- Defined in lib/routes/Webhooks.ts:55

deleteMessage

deleteMessage(webhookID: string, token: string, messageID: string, options?: DeleteWebhookMessageOptions): Promise<void>
Delete a webhook message.
Parameters
- webhookID: string
  
  The ID of the webhook.
- token: string
  
  The token of the webhook.
- messageID: string
  
  The ID of the message.
- Optional options: DeleteWebhookMessageOptions
  
  The options for deleting the message.
Returns Promise<void>
- Defined in lib/routes/Webhooks.ts:70

deleteToken

deleteToken(webhookID: string, token: string): Promise<void>
Delete a webhook via its token.
Parameters
- webhookID: string
  
  The ID of the webhook.
- token: string
  
  The token of the webhook.
Returns Promise<void>
- Defined in lib/routes/Webhooks.ts:86

edit

edit(webhookID: string, options: EditWebhookOptions): Promise<Webhook>
Edit a webhook.
Parameters
- webhookID: string
  
  The ID of the webhook.
- options: EditWebhookOptions
  
  The options for editing the webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Webhooks.ts:98

editMessage

editMessage<T>(webhookID: string, token: string, messageID: string, options: EditWebhookMessageOptions): Promise<Message<T>>
Edit a webhook message.
Type Parameters
- T extends Uncached | AnyTextChannelWithoutGroup
Parameters
- webhookID: string
  
  The ID of the webhook.
- token: string
  
  The token of the webhook.
- messageID: string
  
  The ID of the message to edit.
- options: EditWebhookMessageOptions
  
  The options for editing the message.
Returns Promise<Message<T>>
- Defined in lib/routes/Webhooks.ts:125

editToken

editToken(webhookID: string, token: string, options: EditWebhookTokenOptions): Promise<Webhook>
Edit a webhook via its token.
Parameters
- webhookID: string
  
  The ID of the webhook.
- token: string
- options: EditWebhookTokenOptions
  
  The options for editing the webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Webhooks.ts:154

execute

execute<T>(webhookID: string, token: string, options: ExecuteWebhookWaitOptions): Promise<Message<T>>
Execute a webhook.
Type Parameters
- T extends Uncached | AnyTextChannelWithoutGroup
Parameters
- webhookID: string
  
  The ID of the webhook.
- token: string
  
  The token of the webhook.
- options: ExecuteWebhookWaitOptions
  
  The options for executing the webhook.
Returns Promise<Message<T>>
- Defined in lib/routes/Webhooks.ts:174
execute(webhookID: string, token: string, options: ExecuteWebhookOptions): Promise<void>
Parameters
- webhookID: string
- token: string
- options: ExecuteWebhookOptions
Returns Promise<void>
- Defined in lib/routes/Webhooks.ts:175

executeGithub

executeGithub(webhookID: string, token: string, options: Record<string, unknown> & {
wait: false;
}): Promise<void>
Execute a GitHub compatible webhook.
Parameters
- webhookID: string
  
  The ID of the webhook.
- token: string
  
  The token of the webhook.
- options: Record<string, unknown> & {
  wait: false;
  }
  
  The options to send. See GitHub's documentation for more information.
Returns Promise<void>
- Defined in lib/routes/Webhooks.ts:218
executeGithub<T>(webhookID: string, token: string, options: Record<string, unknown> & {
wait?: true;
}): Promise<Message<T>>
Type Parameters
- T extends Uncached | AnyTextChannelWithoutGroup
Parameters
- webhookID: string
- token: string
- options: Record<string, unknown> & {
  wait?: true;
  }
Returns Promise<Message<T>>
- Defined in lib/routes/Webhooks.ts:219

executeSlack

executeSlack(webhookID: string, token: string, options: Record<string, unknown> & {
wait: false;
}): Promise<void>
Execute a slack compatible webhook.
Parameters
- webhookID: string
  
  The ID of the webhook.
- token: string
  
  The token of the webhook.
- options: Record<string, unknown> & {
  wait: false;
  }
  
  The options to send. See Slack's Documentation for more information.
Returns Promise<void>
- Defined in lib/routes/Webhooks.ts:243
executeSlack<T>(webhookID: string, token: string, options: Record<string, unknown> & {
wait?: true;
}): Promise<Message<T>>
Type Parameters
- T extends Uncached | AnyTextChannelWithoutGroup
Parameters
- webhookID: string
- token: string
- options: Record<string, unknown> & {
  wait?: true;
  }
Returns Promise<Message<T>>
- Defined in lib/routes/Webhooks.ts:244

get

get(webhookID: string, token?: string): Promise<Webhook>
Get a webhook by ID (and optionally token).
Parameters
- webhookID: string
  
  The ID of the webhook.
- Optional token: string
  
  The token of the webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Webhooks.ts:267

getForChannel

getForChannel(channelID: string): Promise<Webhook[]>
Get the webhooks in the specified channel.
Parameters
- channelID: string
  
  The ID of the channel to get the webhooks of.
Returns Promise<Webhook[]>
- Defined in lib/routes/Webhooks.ts:278

getForGuild

getForGuild(guildID: string): Promise<Webhook[]>
Get the webhooks in the specified guild.
Parameters
- guildID: string
  
  The ID of the guild to get the webhooks of.
Returns Promise<Webhook[]>
- Defined in lib/routes/Webhooks.ts:289

getMessage

getMessage<T>(webhookID: string, token: string, messageID: string, threadID?: string): Promise<Message<T>>
Get a webhook message.
Type Parameters
- T extends Uncached | AnyTextChannelWithoutGroup
Parameters
- webhookID: string
  
  The ID of the webhook.
- token: string
  
  The token of the webhook.
- messageID: string
  
  The ID of the message.
- Optional threadID: string
  
  The ID of the thread the message is in.
Returns Promise<Message<T>>
- Defined in lib/routes/Webhooks.ts:303

Class Webhooks

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns Webhooks

Methods

create

Parameters

channelID: string

options: CreateWebhookOptions

Returns Promise<Webhook>

delete

Parameters

webhookID: string

Optional reason: string

Returns Promise<void>

deleteMessage

Parameters

webhookID: string

token: string

messageID: string

Optional options: DeleteWebhookMessageOptions

Returns Promise<void>

deleteToken

Parameters

webhookID: string

token: string

Returns Promise<void>

edit

Parameters

webhookID: string

options: EditWebhookOptions

Returns Promise<Webhook>

editMessage

Type Parameters

T extends Uncached | AnyTextChannelWithoutGroup

Parameters

webhookID: string

token: string

messageID: string

options: EditWebhookMessageOptions

Returns Promise<Message<T>>

editToken

Parameters

webhookID: string

token: string

options: EditWebhookTokenOptions

Returns Promise<Webhook>

execute

Type Parameters

T extends Uncached | AnyTextChannelWithoutGroup

Parameters

webhookID: string

token: string

options: ExecuteWebhookWaitOptions

Returns Promise<Message<T>>

Parameters

webhookID: string

token: string

options: ExecuteWebhookOptions

Returns Promise<void>

executeGithub

Parameters

webhookID: string

token: string

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

Returns Promise<void>

Type Parameters

T extends Uncached | AnyTextChannelWithoutGroup

Parameters

webhookID: string

token: string

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

Returns Promise<Message<T>>

executeSlack

`Optional` reason: string

`Optional` options: DeleteWebhookMessageOptions

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

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

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

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

`Optional` token: string

`Optional` threadID: string