Webhook

Un Webhook est un moyen de publier des messages dans un salon sous n’importe quel nom. Vous en obtenez un depuis channel.createWebhook(), channel.fetchWebhooks() ou 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 });
}

Ce que peut contenir un message est dans Messages ; ce que prend send() ici est WebhookMessageOptions.

Le token d’un webhook permet à n’importe qui de publier avec. Il n’apparaît jamais quand vous affichez un webhook ou appelez toJSON(), et le bot ne le donne jamais à votre code.

Propriétés

Snowflake

L’identifiant unique que Discord lui a donné.

Date

Quand il a été créé : un identifiant Discord contient sa date de création.

string | null

Le nom par défaut avec lequel publie le webhook.

Snowflake | null

L’identifiant du salon où publie le webhook.

Snowflake | null

L’identifiant du serveur du webhook.

boolean

Si le bot peut publier avec : seulement les webhooks qu’il a créés.

Helpers

Ils lisent ce dont le bot se souvient : ils n’envoient jamais de requête.

toJSON()

toJSON(): object

Les données du webhook, sans son token : un token est un secret.

Actions

send()

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

Publie un message avec le webhook. Un texte seul est son contenu ; voir WebhookMessageOptions pour le reste. Seul le bot qui a créé un webhook peut publier avec (canSend). Sinon send() lève une erreur :

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

Documentation de Discord

edit()

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

Change le nom, l’avatar ou le salon du webhook. Voir les options de modification d’un webhook. Documentation de Discord

delete()

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

Supprime le webhook. Documentation de Discord

Types

Options de modification d’un webhook

Ce que prend edit(). Chaque champ peut être laissé de côté : seul ce que vous passez change.

string

Le nom par défaut du webhook.

string | null

L’image de l’avatar par défaut du webhook, sous forme de data URI (data:image/png;base64,...) ; null la retire.

Snowflake

L’identifiant du salon vers lequel déplacer le webhook.

Documentation de Discord WebhookMessageOptions est dans Options des messages.

Référence

Vos fichiers

Structures

Types

CLI

Propriétés

Helpers

toJSON()

Actions

send()

edit()

delete()

Types

Options de modification d’un webhook