discord.js | Webhook

Search...

Webhook

export class Webhook extends WebhookMixin()

export class Webhook extends WebhookMixin()

Represents a webhook.

Extends

WebhookMixin()

applicationId:Snowflake | null

The application that created this webhook

avatar:string | null

The avatar for the webhook

Readonly

The channel the webhook belongs to

channelId:Snowflake

The id of the channel the webhook belongs to

Readonly

client:Client

The client that instantiated the webhook

Readonly

createdAt:Date

The time the webhook was created at

Readonly

createdTimestamp:number

The timestamp the webhook was created at

guildId:Snowflake

The guild the webhook belongs to

id:Snowflake

The webhook's id

name:string

The name of the webhook

owner:User | APIUser | null

The owner of the webhook

sourceChannel:NewsChannel | APIPartialChannel | null

The source channel of the webhook

sourceGuild:Guild | APIPartialGuild | null

The source guild of the webhook

token:string | null

The token for the webhook, unavailable for follower webhooks and webhooks owned by another application.

type:WebhookType

The type of the webhook

Readonly

url:string

The URL of this webhook

avatarURL(options?):string | null

A link to the webhook's avatar.

Returns

Name	Type	Optional	Description
options	ImageURLOptions	Yes	Options for the image URL

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<Message>

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<Message>

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.

isApplicationCreated():this is this & { type: WebhookType.Application; applicationId: Snowflake; owner: User | APIUser; }

Whether this webhook is created by an application.

isChannelFollower():this is this & { type: WebhookType.ChannelFollower; sourceGuild: Guild | APIPartialGuild; sourceChannel: NewsChannel | APIPartialChannel; token: null; applicationId: null; owner: User | APIUser; }

Whether or not this webhook is a channel follower webhook.

isIncoming():this is this & { type: WebhookType.Incoming; token: string; }

Whether or not this webhook is an incoming webhook.

isUserCreated():this is this & { type: WebhookType.Incoming; applicationId: null; owner: User | APIUser; }

Whether this webhook is created by a user.

send(options):Promise<Message>

Sends a message with this webhook.

Example

// Send a basic message
webhook.send('hello!')
  .then(message => console.log(`Sent message: ${message.content}`))
  .catch(console.error);

// Send a basic message
webhook.send('hello!')
  .then(message => console.log(`Sent message: ${message.content}`))
  .catch(console.error);

Example

// Send a basic message in a thread
webhook.send({ content: 'hello!', threadId: '836856309672348295' })
  .then(message => console.log(`Sent message: ${message.content}`))
  .catch(console.error);

// Send a basic message in a thread
webhook.send({ content: 'hello!', threadId: '836856309672348295' })
  .then(message => console.log(`Sent message: ${message.content}`))
  .catch(console.error);

Example

// Send a remote file
webhook.send({
  files: ['https://cdn.discordapp.com/icons/222078108977594368/6e1019b3179d71046e463a75915e7244.png?size=2048']
})
  .then(console.log)
  .catch(console.error);

// Send a remote file
webhook.send({
  files: ['https://cdn.discordapp.com/icons/222078108977594368/6e1019b3179d71046e463a75915e7244.png?size=2048']
})
  .then(console.log)
  .catch(console.error);

Example

// Send a local file
webhook.send({
  files: [{
    attachment: 'entire/path/to/file.jpg',
    name: 'file.jpg'
  }]
})
  .then(console.log)
  .catch(console.error);

// Send a local file
webhook.send({
  files: [{
    attachment: 'entire/path/to/file.jpg',
    name: 'file.jpg'
  }]
})
  .then(console.log)
  .catch(console.error);

Example

// Send an embed with a local image inside
webhook.send({
  content: 'This is an embed',
  embeds: [{
    thumbnail: {
         url: 'attachment://file.jpg'
      }
   }],
   files: [{
      attachment: 'entire/path/to/file.jpg',
      name: 'file.jpg'
   }]
})
  .then(console.log)
  .catch(console.error);

// Send an embed with a local image inside
webhook.send({
  content: 'This is an embed',
  embeds: [{
    thumbnail: {
         url: 'attachment://file.jpg'
      }
   }],
   files: [{
      attachment: 'entire/path/to/file.jpg',
      name: 'file.jpg'
   }]
})
  .then(console.log)
  .catch(console.error);

Name	Type	Optional	Description
options	string \| MessagePayload \| WebhookMessageCreateOptions	No	The options to provide

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