discord.js | WebhookClient

Search...

WebhookClient

export class WebhookClient extends WebhookMixin(BaseClient)

export class WebhookClient extends WebhookMixin(BaseClient)

The webhook client.

Extends

WebhookMixin(BaseClient)

constructor(data, options?)

Name	Type	Optional	Description
data	WebhookClientData	No	None
options	WebhookClientOptions	Yes	None

Readonly

client:this

Readonly

createdAt:Date

The time the webhook was created at

Readonly

createdTimestamp:number

The timestamp the webhook was created at

id:Snowflake

The webhook's id

options:WebhookClientOptions

The options the webhook client was instantiated with.

token:string

Readonly

url:string

The URL of this webhook

delete(reason?):Promise<void>

Deletes the webhook.

Name	Type	Optional	Description
reason	string	Yes	Reason for deleting this webhook

deleteMessage(message, threadId?):Promise<void>

Delete a message that was sent by this webhook.

Name	Type	Optional	Description
message	MessageResolvable \| '@original'	No	The message to delete
threadId	Snowflake	Yes	The id of the thread this message belongs to

edit(options):Promise<Webhook>

Edits this webhook.

Name	Type	Optional	Description
options	WebhookEditOptions	No	Options for editing the webhook

editMessage(message, options):Promise<APIMessage>

Edits a message that was sent by this webhook.

Returns

Returns the message edited by this webhook

Name	Type	Optional	Description
message	MessageResolvable	No	The message to edit
options	string \| MessagePayload \| WebhookMessageEditOptions	No	The options to provide

fetchMessage(message, options?):Promise<APIMessage>

Gets a message that was sent by this webhook.

Returns

Returns the message sent by this webhook

Name	Type	Optional	Description
message	Snowflake	No	The id of the message to fetch
options	WebhookFetchMessageOptions	Yes	The options to provide to fetch the message.

send(options):Promise<APIMessage>

Sends a message with this webhook.

Name	Type	Optional	Description
options	string \| MessagePayload \| WebhookMessageCreateOptions	No	The content for the reply

sendSlackMessage(body):Promise<boolean>

Sends a raw slack message with this webhook.

Example

// Send a slack message
webhook.sendSlackMessage({
  'username': 'Wumpus',
  'attachments': [{
    'pretext': 'this looks pretty cool',
    'color': '#F0F',
    'footer_icon': 'http://snek.s3.amazonaws.com/topSnek.png',
    'footer': 'Powered by sneks',
    'ts': Date.now() / 1_000
  }]
}).catch(console.error);

// Send a slack message
webhook.sendSlackMessage({
  'username': 'Wumpus',
  'attachments': [{
    'pretext': 'this looks pretty cool',
    'color': '#F0F',
    'footer_icon': 'http://snek.s3.amazonaws.com/topSnek.png',
    'footer': 'Powered by sneks',
    'ts': Date.now() / 1_000
  }]
}).catch(console.error);

Name	Type	Optional	Description
body	object	No	The raw body to send