Class REST/Webhooks

Various methods for interacting with webhooks. Located at Client#rest .webhooks.

Hierarchy

REST/Webhooks

Index

Constructors

Methods

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

Constructors

constructor

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

Methods

create

create(channelID, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:32

delete

delete(webhookID, reason?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:57

deleteMessage

deleteMessage(webhookID, token, messageID, options?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:73

deleteToken

deleteToken(webhookID, token): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:90

edit

edit(webhookID, options): Promise<Webhook>
Edit a webhook.
Parameters
- webhookID: string
  
  The ID of the webhook.
- options: EditWebhookOptions
  
  The options for editing the webhook.
Returns Promise<Webhook>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:103

editMessage

editMessage<T>(webhookID, token, messageID, options): Promise<Message<T>>
Edit a webhook message.
Type Parameters
- T extends Uncached | AnyTextableChannel
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>>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:131

editToken

editToken(webhookID, token, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:161

execute

execute<T>(webhookID, token, options): Promise<Message<T>>
Execute a webhook.
Type Parameters
- T extends Uncached | AnyTextableChannel
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>>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:182
execute(webhookID, token, options): Promise<void>
Parameters
- webhookID: string
- token: string
- options: ExecuteWebhookOptions
Returns Promise<void>
- Defined in lib/routes/Webhooks.ts:183

executeGithub

executeGithub(webhookID, token, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:223
executeGithub<T>(webhookID, token, options): Promise<Message<T>>
Type Parameters
- T extends Uncached | AnyTextableChannel
Parameters
- webhookID: string
- token: string
- options: Record<string, unknown> & {
  wait?: true;
  }
Returns Promise<Message<T>>
- Defined in lib/routes/Webhooks.ts:224

executeSlack

executeSlack(webhookID, token, options): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:245
executeSlack<T>(webhookID, token, options): Promise<Message<T>>
Type Parameters
- T extends Uncached | AnyTextableChannel
Parameters
- webhookID: string
- token: string
- options: Record<string, unknown> & {
  wait?: true;
  }
Returns Promise<Message<T>>
- Defined in lib/routes/Webhooks.ts:246

get

get(webhookID, token?): 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>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:266

getForChannel

getForChannel(channelID): 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[]>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:278

getForGuild

getForGuild(guildID): 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[]>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:290

getMessage

getMessage<T>(webhookID, token, messageID, threadID?): Promise<Message<T>>
Get a webhook message.
Type Parameters
- T extends Uncached | AnyTextableChannel
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>>

Caching
This method does not cache its result.
- Defined in lib/routes/Webhooks.ts:305

Class REST/Webhooks

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns REST/Webhooks

Methods

create

Parameters

channelID: string

options: CreateWebhookOptions

Returns Promise<Webhook>

Caching

delete

Parameters

webhookID: string

Optional reason: string

Returns Promise<void>

Caching

deleteMessage

Parameters

webhookID: string

token: string

messageID: string

Optional options: DeleteWebhookMessageOptions

Returns Promise<void>

Caching

deleteToken

Parameters

webhookID: string

token: string

Returns Promise<void>

Caching

edit

Parameters

webhookID: string

options: EditWebhookOptions

Returns Promise<Webhook>

Caching

editMessage

Type Parameters

T extends Uncached | AnyTextableChannel

Parameters

webhookID: string

token: string

messageID: string

options: EditWebhookMessageOptions

Returns Promise<Message<T>>

Caching

editToken

Parameters

webhookID: string

token: string

options: EditWebhookTokenOptions

Returns Promise<Webhook>

Caching

execute

Type Parameters

T extends Uncached | AnyTextableChannel

Parameters

webhookID: string

token: string

options: ExecuteWebhookWaitOptions

Returns Promise<Message<T>>

Caching

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>

`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