Webhook

A Webhook is a way to post messages in a channel under any name. You get one from channel.createWebhook(), channel.fetchWebhooks() or guild.fetchWebhooks().

import type { TextChannel } from 'chapterjs';

async function relay(channel: TextChannel, author: string, text: string) {
  const webhook = await channel.createWebhook({ name: 'Relay' });
  await webhook.send({ content: text, username: author });
}

What a message can hold is in Messages; what send() takes here is WebhookMessageOptions.

The token of a webhook lets anyone post with it. It never appears when you log a webhook or call toJSON(), and the bot never gives it to your code.

Properties

Snowflake

The unique id Discord gave it.

Date

When it was created: a Discord id contains its creation date.

string | null

The default name the webhook posts with.

Snowflake | null

The id of the channel the webhook posts in.

Snowflake | null

The id of the server of the webhook.

boolean

Whether the bot can post with it: only webhooks it created.

Helpers

These read what the bot remembers: they never send a request.

toJSON()

toJSON(): object

The data of the webhook, without its token: a token is a secret.

Actions

send()

send(message: string | WebhookMessageOptions): Promise<Message>

Posts a message with the webhook. A text alone is its content; see WebhookMessageOptions for the rest. Only the bot that created a webhook can post with it (canSend). Otherwise send() throws:

This webhook was not created by the bot: Discord only lets its creator post with it.

Discord documentation

edit()

edit(
  options: { name?: string; avatar?: string | null; channelId?: Snowflake },
  reason?: string
): Promise<Webhook>

Changes the name, the avatar or the channel of the webhook. See webhook edit options. Discord documentation

delete()

delete(reason?: string): Promise<void>

Deletes the webhook. Discord documentation

Types

Webhook edit options

What edit() takes. Every field can be left out: only what you pass changes.

string

The default name of the webhook.

string | null

The image of the default avatar of the webhook, as a data URI (data:image/png;base64,...); null removes it.

Snowflake

The id of the channel to move the webhook to.

Discord documentation WebhookMessageOptions is in Message options.

Reference

Your files

Structures

Types

CLI

Properties

Helpers

toJSON()

Actions

send()

edit()

delete()

Types

Webhook edit options