Workflow WebhooksWorkflow Webhooks

Sådan forbinder du GitHub med Shopify Flow

GitHub sender en Webhook, hver gang der sker noget i et repository eller en organisation - et push, en udgivelse, en issue, en pull request eller en arbejdsgang. Workflow Webhooks omdanner dette kald til en Shopify Flow-udløser, så din butik kan reagere på det: mærke en kunde, tilføje en ordrebemærkning, sende en intern e-mail, opdatere et metafelt - alt, hvad Shopify Flow kan gøre.

Denne vejledning beskriver hele forløbet - GitHub sender, Workflow Webhooks modtager og verificerer, Shopify Flow udfører handlingen - hvor GitHubs HMAC-signatur kontrolleres ved hver eneste anmodning, så kun GitHub kan igangsætte din arbejdsgang.

Hvad du kan bygge

  • Send en e-mail til dit merchandising-team, når der udsendes en opdatering, der ændrer produktdataene.
  • Skriv den aktuelle build- eller temaversion ind i et metafelt i webshoppen ved hver udgivelse.
  • Giv personalet besked, når en planlagt arbejdsgang mislykkes, ved hjælp af den samme Shopify Flow, som du allerede bruger til andre hændelser.

Typiske hændelser, der skal sendes: push, release (offentliggjort), issues (åbnet, lukket), workflow_run (afsluttet).

Før du går i gang

  • Workflow Webhooks installeret på din Shopify-butik.
  • Shopify Flow installeret, som kan hentes gratis fra App Store på Shopify.
  • En konto på GitHub med tilladelse til at oprette webhooks.

Trin 1 - Opret webhook på Workflow Webhooks

  1. Åbn Workflow Webhooks -> Webhooks -> Opret en webhook, og giv den et navn, du kan genkende i Shopify Flow, f.eks. GitHub events.
  2. Vælg HMAC under »Godkendelse«.
  3. Vælg GitHub under »Signaturudbyder«. Appen udfylder automatisk overskriften, algoritmen, den signerede payload og replay-vinduet for dig - der er ikke andet, du skal konfigurere.
  4. Lad feltet »Secret« være tomt foreløbig, og klik på »Gem«. Kopier den webhook-URL, der vises på siden.

Se Godkendelse for de øvrige godkendelsesmetoder og Kortlægning af payload og strømningsvariabler for at vælge, hvilke felter der skal sendes til Shopify Flow.

Trin 2 - Tilføj endpointet i GitHub

I repositoriet (eller organisationen) skal du åbne Indstillinger -> Webhooks -> Tilføj webhook, indsætte URL’en som Payload-URL, indstille indholdstypen til »application/json« og udfylde feltet »Secret«.

Sådan finder du din GitHub-signeringsnøgle

Den hemmelige nøgle, du har angivet i GitHub-webhooken (Indstillinger → Webhooks → Hemmelig nøgle).

GitHubs egen dokumentation om webhook-signaturer indeholder den nøjagtige ordlyd og skærmbilleder, der gælder for din konto.

Indsæt den hemmelighed i feltet »Secret« for webhooken på Workflow Webhooks og gem. Fra det øjeblik bliver hver eneste GitHub-levering verificeret, før den når frem til Shopify Flow.

Hvad dette kontrollerer

Hvad Værdi
Signaturhoved X-Hub-Signature-256
Hvor underskriften er placeret Værdien i overskriften, efter præfikset sha256=
Hvad der er underskrevet {body}
Underskrift HMAC-SHA256, hex-kodet
Tidspunkt Bruges ikke af denne afsender
Beskyttelse mod gentagelse Ingen - denne afsender underskriver ikke et tidsstempel, så alle gyldige underskrifter forbliver gyldige
Hemmeligheden Bruges som almindelig tekst. Indsæt den nøjagtigt, som afsenderen har angivet den

I den signerede payload er {body} den rå anmodningstekst, byte for byte.

En anmodning, der ikke opfylder et af disse kriterier, afvises med fejlmeddelelsen »401«, registreres i »Historik og fejlfinding« og udløser aldrig en arbejdsgang.

Trin 3 - Opret arbejdsgangen »Shopify Flow«

  1. I »Shopify Flow« skal du oprette en arbejdsgang og vælge udløseren »Workflow Webhooks«.
  2. Tryk på »Optag begivenheder«, og send derefter en testbegivenhed fra GitHub (eller brug funktionen »Send test« i Workflow Webhooks), så Shopify Flow kan lære dine datas struktur at kende.
  3. Hver eneste webhook, du ejer, udløser den samme Shopify Flow-trigger, så tilføj en første betingelse baseret på webhook-id’et for at sikre, at denne arbejdsgang kun omfatter GitHub. Id’et vises på webhook-siden.
  4. Tilføj dine handlinger - tag en kunde, tilføj en note, send en intern e-mail, opdater et metafelt.
Shopify Flow
I »Shopify Flow« skal du vælge »Select a trigger«, åbne »Workflow Webhooks« og vælge »Webhook Trigger«.
I Shopify Flow: Webhook-id'et er det samme som ID'et for en bestemt webhook
Det første trin i enhver arbejdsgang: en betingelse baseret på webhook-id’et, så arbejdsgangen kun udføres for denne webhook.
Den færdige arbejdsgang: Webhook-udløser, en betingelse baseret på webhook-ID’et, og derefter »Send intern e-mail« på »True«-grenen
Den færdige arbejdsgang: udløser, betingelse baseret på webhook-ID’et, og derefter din handling på »True«-grenen.

Trin 4 - Test det fra start til slut

Udløs en reel begivenhed i GitHub. Under »Workflow Webhooks« → »History« bør du kunne se opkaldet med status »Success«. Hvis signaturen var forkert, får du i stedet en fejlmeddelelse med årsagen, og på Bekræftelse af signerede webhooks finder du en forklaring på signaturtestværktøjet, der viser dig præcis, hvilket trin der mislykkedes.

En anmodning, der blev åbnet i History, med dens anmodningsheadere, payload, status, varighed og identifikatorer
En gennemført begivenhed i History: Status »Success« betyder, at Shopify Flow har godkendt den.
Underskriften stemmer ikke overens▾

I denne ordre: hemmeligheden (den mest almindelige årsag - et ekstra mellemrum eller en nøgle fra det forkerte miljø), om afsenderen bruger en anden endpoints hemmelighed, og om noget mellem GitHub og appen omskriver brødteksten. Signaturerne dækker de rå bytes, så en proxy, der omformaterer JSON, ødelægger dem. Signaturtesteren på webhook-siden viser den nøjagtige tekst, der blev signeret.

Jeg får en 401-fejl ved hver eneste forespørgsel▾

Kontroller, at webhookens godkendelse er indstillet til HMAC med GitHub valgt som udbyder, at den hemmelige nøgle er udfyldt, og at GitHub sender til URL’en nøjagtigt som angivet i appen, inklusive koden i slutningen.

Der vises intet under »Historik«▾

Anmodningen blev aldrig modtaget. Tjek URL’en på GitHub igen, og se i GitHubs egen leveringslog, hvilket svar der blev modtaget. En fejlmeddelelse som »404« betyder, at webhooken er forkert eller er blevet slettet, mens en fejlmeddelelse som »429« betyder, at du har overskredet dit abonnements grænse for antallet af kald - se Planer og anvendelse.

Arbejdsgangen kører for de forkerte begivenheder▾

Hver eneste webhook i din butik udløser den samme Shopify Flow-trigger. Tilføj en betingelse baseret på webhook-id’et som det første trin i arbejdsgangen, eller indsnæv de begivenheder, du sender fra GitHub.

Relateret