createStandardWebhook

Rôle et comportement

Crée une source de déclencheur pour les émetteurs qui suivent le schéma Standard Webhooks. Elle vérifie chaque signature v1 de webhook-signature sur id.timestamp.body avec des secrets whsec_ dans une fenêtre d’horodatage, utilise webhook-id comme livraison et le champ type de la charge, ou webhook, comme kind. Elle ne renvoie pas d’acteur.

Exemple complet et règles détaillées.

Paramètres et propriétés

• optionsRequis
  StandardWebhookOptions
  Secret de signature, fenêtre d’horodatage et nom de source.
• options.secretRequis
  TriggerSecret
  Secret whsec_ qui vérifie webhook-signature, ou callback renvoyant chaque secret actuellement accepté (l’ancien et le nouveau pendant une rotation). Une chaîne vide lève une erreur à la création ; un callback en échec ou vide, ou un secret sans préfixe whsec_, refuse les requêtes.
• options.toleranceMsOptionnel
  number | undefined
  Écart d’horloge accepté pour l’horodatage de la requête, en millisecondes ; 300000 (5 minutes) par défaut. Une valeur qui n’est pas un entier positif lève une erreur à la création.
• options.sourceOptionnel
  string | undefined
  Nom indiqué dans TriggerEvent.source ; standard par défaut.

Retour

TriggerSource

Signature

export declare function createStandardWebhook(
  options: StandardWebhookOptions,
): TriggerSource;

Contrats associés

• StandardWebhookOptions
• TriggerSource