Aller au contenu
English

createGithubWebhook

import { createGithubWebhook } from "@elie-laloum/outpost";

Crée une source de déclencheur GitHub. Elle vérifie X-Hub-Signature-256 avec chaque secret courant en temps constant, accepte les charges JSON et formulaire, et renvoie X-GitHub-Delivery, le nom X-GitHub-Event, l’action de la charge et l’émetteur sous la forme github:<login>. Les signatures GitHub ne portent pas d’horodatage.

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

  • optionsRequis
    GithubWebhookOptions
    Réglages du secret du webhook GitHub.
  • options.secretRequis
    TriggerSecret
    Secret du webhook qui vérifie X-Hub-Signature-256, 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 sans secret refuse les requêtes.

TriggerSource

export declare function createGithubWebhook(
  options: GithubWebhookOptions,
): TriggerSource;