Skip to content

WebhookManager ​

Gère le cache des webhooks d'un salon. Instancié par salon (channel.webhooks) — étend BaseManager. Ajouté en 1.5.0.

Notation des signatures

Les signatures sont écrites en notation TypeScript, mais s'appellent à l'identique en JavaScript — voir Utiliser le SDK en JavaScript.

Le cache (channel.webhooks.cache) est une Collection<string, Webhook> indexée par publicId — voir Webhook pour la structure complète (notamment la gestion du token).

Méthodes ​

fetchAll(cache = true): Promise<Webhook[]> ​

Récupère tous les webhooks configurés dans ce salon. Vide et repeuple cache si cache vaut true (par défaut).

ts
const webhooks = await channel.webhooks.fetchAll();
console.log(`${webhooks.length} webhook(s) sur ce salon.`);
js
const webhooks = await channel.webhooks.fetchAll();
console.log(`${webhooks.length} webhook(s) sur ce salon.`);

create(options): Promise<Webhook> ​

Crée un nouveau webhook dans ce salon.

ts
create(options: { name: string; avatarUrl?: string }): Promise<Webhook>
ParamètreTypeRequisDescription
options.namestringOuiNom d'affichage par défaut du webhook.
options.avatarUrlstringNonAvatar par défaut.

Ajoute automatiquement le webhook créé à cache. L'instance retournée porte son token — seul moment où il est disponible en dehors d'un fetch explicite avec token.

ts
const webhook = await channel.webhooks.create({ name: "Déploiements" });
await webhook.send("🚀 Nouvelle version déployée !");
js
const webhook = await channel.webhooks.create({ name: "Déploiements" });
await webhook.send("🚀 Nouvelle version déployée !");

delete(webhookId): Promise<void> ​

Supprime un webhook par son publicId. Retire aussi l'entrée de cache. Équivalent à webhook.delete() si vous avez déjà l'instance sous la main.

ts
await channel.webhooks.delete(webhook.id);
js
await channel.webhooks.delete(webhook.id);

Channel.fetchWebhooks() / Channel.createWebhook() délèguent ici

Les raccourcis historiques sur Channel appellent respectivement channel.webhooks.fetchAll() et channel.webhooks.create() — même comportement, mêmes résultats. channel.webhooks est simplement la forme la plus directe, et la seule à exposer cache/delete().

Voir aussi ​

SDK publié sous licence ISC.