LegbaWebhookError

expérimentaldepuis 0.1.0@legba-core/realtime

LegbaWebhookError

Ce que ça fait

Erreur levée par verifyWebhook/processWebhook quand la signature d’un webhook LiveKit est absente ou invalide.

Signature

class LegbaWebhookError extends LegbaError {
  constructor(code: WebhookErrorCode, message: string);
}

Paramètres

NomTypeRequisDéfautDescription
codeWebhookErrorCodeouiUn des codes de WEBHOOK_ERROR_CODES
messagestringouiMessage actionnable

Retour

Une instance de LegbaWebhookError, avec name === "LegbaWebhookError".

Erreurs

N/A — c’est la classe d’erreur elle-même.

Exemple minimal

import { LegbaWebhookError } from "@legba-core/realtime";

try {
  await webhooks.verifyWebhook(body, authHeader);
} catch (error) {
  if (error instanceof LegbaWebhookError) {
    // corps rejeté avant tout traitement du contenu
  }
}

Exemple complet

Voir createWebhookService.

Pièges

  • Un seul code existe aujourd’hui (INVALID_SIGNATURE), qui regroupe plusieurs causes distinctes côté SDK LiveKit (en-tête Authorization absent, JWT invalide/expiré, sha256 du corps ne correspondant pas) : le message précise la cause réelle, pas error.code seul.

Voir aussi