22 / 05 / 2023
Nella breve guida di seguito si spiega come utilizzare i webhook su Shopify ed in particolare come collegare il sistema di donazioni di GrowishCharity
Cos’è un webhook ed a cosa serve?
I webhook sono uno strumento necessario per sincronizzare app e servizi esterni, ed eseguire un codice al verificarsi di un evento specifico in negozio, ad esempio quando viene creato un nuovo prodotto o effettuato un ordine. Nel caso di questa guida, il webhook serve a comunicare a Growish Charity che un cliente ha completato un ordine per poter attivare il sistema di donazioni.
Come creare un webhook
- Dal tuo pannello di amministrazione Shopify, vai su Impostazioni> Notifiche
- Scorrendo verso il basso, troverai la sezione Webhooks
- Fai clic su Crea un webhook
Elementi di un webhook
Per creare un webhook è necessario disporre dei seguenti elementi:
- Evento (ciò che deve verificarsi sullo store affinchè il webhook si attivi, ad esempio un Ordine completato)
- Formato
- URL di destinazione del webhook
- Versione API
Configurazione del webhook per GrowishCharity
Per configurare il webhook di GrowishCharity, è necessario compilare i campi come di seguito:
- Evento: l’evento da collegare è Pagamento ordine (è preferibile rispetto ad Ordine evaso in quanto l’evasione dell’ordine potrebbe non coincidere con l’acquisizione del pagamento, basti pensare al contrassegno)
- Formato: JSON
- URL: qui è necessario inserire la URL che GrowishCharity ha generato al momento dell’attivazione dell’account. La url somiglierà a questa:
https://hooks.growish.com/charity/[merchantId]
- MerchantID: si riferisce al proprio codice identificativo cliente e viene fornito da GrowishCharity.
- Versione API Webhook: è consigliabile usare la più recente o seguire le indicazioni in merito dello staff tecnico di GrowishCharity
A questo punto, clicca su Salva Webhook
Codice di autenticazione e Notifiche di prova
Dopo aver salvato il webhook, ti troverai di fronte ad un elemento molto simile a questo:
In basso, è mostrata la chiave segreta di autenticazione che fa capo al tuo store e che viene automaticamente aggiunta alle notifiche inviate.
Sulla destra, invece, accanto a “Formato”, è possibile cliccare Invia notifica di prova per effettuare un test del webhook e verificare che sia tutto settato correttamente, di concerto col team di GrowishCharity.
Note aggiuntive
- Se stai usando Cloudflare sul tuo dominio, dovresti disabilitarlo per l’URL del webhook registrato.
- Shopify verifica i certificati SSL durante la consegna di payload agli indirizzi webhook HTTPS. Assicurarsi che il server sia configurato correttamente per supportare HTTPS con un certificato SSL valido.
- Risposta a un webhook :Il tuo webhook riconosce di aver ricevuto dati inviando una risposta di 200 OK. Qualsiasi risposta al di fuori dell’intervallo 200, inclusi i codici di reindirizzamento HTTP 3XX, indica che non è stato ricevuto il webhook. Shopify non segue i reindirizzamenti per le notifiche webhook e le considera una risposta di errore.
- Frequenza: Shopify attende cinque secondi per una risposta a ciascuna richiesta a un webhook. Se non viene fornita alcuna risposta o viene restituito un errore, Shopify ritenta la connessione 19 volte nelle successive 48 ore. Se si verificano 19 errori consecutivi, il webhook viene eliminato.