Guide pratiche

Rendi affidabili i webhook e le integrazioni del sito web

Un'integrazione richiede più della ricezione di una notifica. Deve distinguere eventi validi, duplicati, ritardi ed elaborazioni interrotte per evitare di ripetere le operazioni aziendali.

vedere il metodo

Un evento, un'operazione

Scrivi il contratto dell'evento

Documentare il produttore, i tipi di eventi previsti, i campi obbligatori e l'operazione attivata. Descrivere i risultati per la creazione, la modifica e l'eliminazione, ove applicabile. Una notifica non dovrebbe autorizzare implicitamente ogni possibile azione.

Scegli un identificatore di tracciamento e una fonte autorevole da consultare quando incerto. Descrivi come vengono rilevati i guasti al produttore o al ricevitore. La documentazione di integrazione contiene regole e proprietari; I segreti appartengono al meccanismo sicuro del progetto.

Verificare prima di attivare un'operazione

GitHub Documenti di consegna Convalida della firma utilizzando il payload configurato e segreto configurato. seguire il meccanismo documentato del fornitore effettivo; Intestazioni, algoritmi e formati non dovrebbero essere copiati da un altro servizio per analogia.

Verifica dell'origine separata, convalida dello schema e autorizzazione all'operazione. Testare il contenuto alterato, un tipo di evento imprevisto e un campo mancante. L'elaborazione aziendale dovrebbe iniziare solo dopo i controlli richiesti per il caso d'uso.

Pianifica ripetizioni e interruzioni

Definire la gestione idempotente: una consegna ripetuta riconosciuta non deve creare due ordini o due notifiche finali. Test ripetizione prima, durante e dopo l'elaborazione e un'interruzione tra le fasi. Il meccanismo dipende dal funzionamento e dallo stoccaggio coinvolti.

Controllare le garanzie di ordinazione e riconsegna del fornitore piuttosto che assumere un arrivo una tantum immediato. Mantieni una coda di lavoro che richiede una revisione e un modo per riconciliarlo con il sorgente. Una risposta tecnica positiva dovrebbe corrispondere a uno stato di elaborazione definito.

Organizzare il monitoraggio e il recupero

Registrare un identificatore di evento, uno stato e un errore utile riducendo al minimo i dati. Definire chi monitora i guasti, come vengono riprovati gli eventi autorizzati e come i tentativi evitano la duplicazione del lavoro completato.

interrompere il ricevitore in un ambiente di test e ripristinarlo. Controllare il recupero e riconciliare i risultati aziendali previsti. Consegna un contratto di evento, un batch di test, una cronologia di elaborazione e una procedura di recupero che il team può utilizzare.

Documentazione primaria: GitHub: convalida delle consegne di webhook.

Contenuto aggiornato 1 ottobre 2026

Matrice di convalida funzionale per adattarsi al progetto

Questi controlli proposti utilizzano casi fittizi. Decidi quale comportamento è previsto con il team, annota il risultato e assegna discrepanze irrisolte prima della pubblicazione.

Casi di test, risultati attesi e prove utili
Casorisultato attesoProva da mantenere
Consegna validaL'evento consentito attiva un'azione prevista che può essere tracciata.Identificatore di consegna, risultato dell'elaborazione e stato dell'attività risultante nel sistema di test.
Corpo modificato o firma non validaL'elaborazione aziendale non inizia mai per l'evento rifiutato.Rifiuto osservato utilizzando una notifica completamente sintetica e un materiale di verifica di sola prova.
Stessa consegna ricevuta due volteLa ripetizione non crea alcuna operazione commerciale aggiuntiva indesiderata.Numero e identificatori delle operazioni registrate dopo entrambi i tentativi controllati.
Eventi ritardati o invertitiLa regola di ordinazione impedisce alle informazioni più vecchie di sostituire uno stato più recente.Cronologia controllata e stato finale documentato, comprese eventuali limitazioni di ordinazione.

Domande frequenti

Perché inviare lo stesso evento più di una volta in un test?

Per garantire che una ripetizione non attivi duplicare operazioni aziendali. I fornitori possono supportare o produrre la riconsegna; I ricevitori devono comprendere le regole e mantenere l'appropriato stato di elaborazione.

È sufficiente una firma valida?

Contribuisce alla verifica dell'origine e dell'integrità in base al meccanismo utilizzato. Il tipo di evento, i dati richiesti, le azioni consentite e lo stato di elaborazione devono ancora essere controllati prima di un'operazione aziendale.